diff --git a/HACKING b/HACKING index 6caf33b26..42b0e7a94 100644 --- a/HACKING +++ b/HACKING @@ -1,9 +1,9 @@ Hacking ======= -This is a guide about how to start hacking on *NavalPlan* project. If you want -more information about *NavalPlan* development you should visit the wiki -available at: http://wiki.navalplan.org/. +This is a guide about how to start hacking on *LibrePlan* project. If you want +more information about *LibrePlan* development you should visit the wiki +available at: http://wiki.libreplan.org/. .. contents:: @@ -48,7 +48,7 @@ Compilation requirements Required for printing -NavalPlan compilation +LibrePlan compilation --------------------- Debian/Ubuntu @@ -72,7 +72,7 @@ Debian/Ubuntu * Download source code:: - $ git clone git://navalplan.git.sourceforge.net/gitroot/navalplan/navalplan + $ git clone git://libreplan.git.sourceforge.net/gitroot/libreplan/libreplan * Compile project:: @@ -80,10 +80,10 @@ Debian/Ubuntu * Launch application:: - $ cd navalplanner-webapp/ + $ cd libreplan-webapp/ $ mvn jetty:run -* Go to http://localhost:8080/navalplanner-webapp/ +* Go to http://localhost:8080/libreplan-webapp/ Fedora ~~~~~~ @@ -121,7 +121,7 @@ Fedora * Download source code:: - $ git clone git://navalplan.git.sourceforge.net/gitroot/navalplan/navalplan + $ git clone git://libreplan.git.sourceforge.net/gitroot/libreplan/libreplan * Compile project:: @@ -129,10 +129,10 @@ Fedora * Launch application:: - $ cd navalplanner-webapp/ + $ cd libreplan-webapp/ $ mvn jetty:run -* Go to http://localhost:8080/navalplanner-webapp/ +* Go to http://localhost:8080/libreplan-webapp/ openSUSE ~~~~~~~~ @@ -181,7 +181,7 @@ openSUSE * Download source code:: - $ git clone git://navalplan.git.sourceforge.net/gitroot/navalplan/navalplan + $ git clone git://libreplan.git.sourceforge.net/gitroot/libreplan/libreplan * Compile project:: @@ -189,10 +189,10 @@ openSUSE * Launch application:: - $ cd navalplanner-webapp/ + $ cd libreplan-webapp/ $ mvn jetty:run -* Go to http://localhost:8080/navalplanner-webapp/ +* Go to http://localhost:8080/libreplan-webapp/ CutyCapt compilation @@ -269,7 +269,7 @@ openSUSE Compilation profiles -------------------- -There are different compilation profiles in *NavalPlan*. Check ```` +There are different compilation profiles in *LibrePlan*. Check ```` section in root ``pom.xml`` to see the different profiles (there are also some profiles defined in ``pom.xml`` of business and webapp modules). @@ -299,14 +299,14 @@ profiles defined in ``pom.xml`` of business and webapp modules). * *reports* - JasperReports (default) - If it is active *NavalPlan* reports are compiled. + If it is active *LibrePlan* reports are compiled. It is useful to disable this profile to save compilation time during development. * *userguide* - User documentation (default) - If it is active *NavalPlan* help is compiled and HTML files are generated. + If it is active *LibrePlan* help is compiled and HTML files are generated. User documentation is written in *reStructuredText* and it is generated automatically thanks to this profile. @@ -344,7 +344,7 @@ command. For example: Tests ----- -*NavalPlan* has a lot of JUnit test that by default are passed when you compile +*LibrePlan* has a lot of JUnit test that by default are passed when you compile the project with Maven. You can use ``-DskipTests`` to avoid tests are passed always. Anyway, you should check that tests are not broken before sending or pushing a patch. @@ -372,5 +372,5 @@ For MySQL users here are specific instructions. * Launch application:: - $ cd navalplanner-webapp/ + $ cd libreplan-webapp/ $ mvn -Pdev,mysql jetty:run diff --git a/INSTALL b/INSTALL index 127a67e20..4615a15ac 100644 --- a/INSTALL +++ b/INSTALL @@ -1,14 +1,14 @@ Install ======= -This is a guide about how to install *NavalPlan* project in your system. If you -want to upgrade your *NavalPlan* version see ``UPDATE`` file. If you want to +This is a guide about how to install *LibrePlan* project in your system. If you +want to upgrade your *LibrePlan* version see ``UPDATE`` file. If you want to know how to compile it manually see ``HACKING`` file. .. contents:: -NavalPlan automatic installation +LibrePlan automatic installation -------------------------------- Ubuntu PPAs @@ -22,31 +22,31 @@ Instructions:: $ sudo add-apt-repository ppa:libreplan/ppa $ sudo apt-get update - $ sudo apt-get install navalplan + $ sudo apt-get install libreplan Debian packages ~~~~~~~~~~~~~~~ There are Debian packages for Squeeze (i386 and amd64), you can download them -from: http://sourceforge.net/projects/navalplan/files/NavalPlan/ +from: http://sourceforge.net/projects/libreplan/files/LibrePlan/ Instructions: * Download the package:: - $ wget http://downloads.sourceforge.net/project/navalplan/NavalPlan/navalplan_1.1.1-1_amd64.deb + $ wget http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.1.1-1_amd64.deb * Install package:: - # dpkg -i navalplan_1.1.1-1_amd64.deb + # dpkg -i libreplan_1.1.1-1_amd64.deb * Install dependencies:: # apt-get install -f -NavalPlan manual installation +LibrePlan manual installation ----------------------------- Debian/Ubuntu @@ -62,44 +62,44 @@ Debian/Ubuntu * Use SQL sentences to create database:: - CREATE DATABASE navalplan; - CREATE USER navalplan WITH PASSWORD 'navalplan'; - GRANT ALL PRIVILEGES ON DATABASE navalplan TO navalplan; + CREATE DATABASE libreplan; + CREATE USER libreplan WITH PASSWORD 'libreplan'; + GRANT ALL PRIVILEGES ON DATABASE libreplan TO libreplan; * Download database installation script:: - $ wget -O install.sql http://downloads.sourceforge.net/project/navalplan/NavalPlan/install_1.1.1.sql + $ wget -O install.sql http://downloads.sourceforge.net/project/libreplan/LibrePlan/install_1.1.1.sql * Create database structure:: - $ psql -h localhost -U navalplan -W navalplan < install.sql + $ psql -h localhost -U libreplan -W libreplan < install.sql * Download ``.war`` file from SourceForge.net:: - $ wget -O navalplan.war http://downloads.sourceforge.net/project/navalplan/NavalPlan/navalplan_1.1.1.war + $ wget -O libreplan.war http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.1.1.war -* Create a new file ``/etc/tomcat6/Catalina/localhost/navalplan.xml`` (file +* Create a new file ``/etc/tomcat6/Catalina/localhost/libreplan.xml`` (file name has to match with ``.war`` name) with database configuration for Tomcat 6:: - + url="jdbc:postgresql://localhost/libreplan" /> -* Add a new Tomcat 6 policy file ``/etc/tomcat6/policy.d/51navalplan.policy`` +* Add a new Tomcat 6 policy file ``/etc/tomcat6/policy.d/51libreplan.policy`` with the following content:: - grant codeBase "file:/var/lib/tomcat6/webapps/navalplan/-" { + grant codeBase "file:/var/lib/tomcat6/webapps/libreplan/-" { permission java.security.AllPermission; }; - grant codeBase "file:/var/lib/tomcat6/webapps/navalplan.war" { + grant codeBase "file:/var/lib/tomcat6/webapps/libreplan.war" { permission java.security.AllPermission; }; @@ -108,9 +108,9 @@ Debian/Ubuntu grant codeBase "file:${catalina.home}/bin/tomcat-juli.jar" { ... - // begin:navalplan - permission java.io.FilePermission "${catalina.base}${file.separator}webapps${file.separator}navalplan${file.separator}WEB-INF${file.separator}classes${file.separator}logging.properties", "read"; - // end:navalplan + // begin:libreplan + permission java.io.FilePermission "${catalina.base}${file.separator}webapps${file.separator}libreplan${file.separator}WEB-INF${file.separator}classes${file.separator}logging.properties", "read"; + // end:libreplan ... }; @@ -120,13 +120,13 @@ Debian/Ubuntu * Copy war to Tomcat 6 web applications directory:: - # cp navalplan.war /var/lib/tomcat6/webapps/ + # cp libreplan.war /var/lib/tomcat6/webapps/ * Restart Tomcat 6:: # /etc/init.d/tomcat6 restart -* Go to http://localhost:8080/navalplan/ +* Go to http://localhost:8080/libreplan/ openSUSE @@ -154,9 +154,9 @@ openSUSE * SQL sentences to create database:: - CREATE DATABASE navalplan; - CREATE USER navalplan WITH PASSWORD 'navalplan'; - GRANT ALL PRIVILEGES ON DATABASE navalplan TO navalplan; + CREATE DATABASE libreplan; + CREATE USER libreplan WITH PASSWORD 'libreplan'; + GRANT ALL PRIVILEGES ON DATABASE libreplan TO libreplan; * Set ``postgres`` user password:: @@ -170,29 +170,29 @@ openSUSE * Download database installation script:: - $ wget -O install.sql http://downloads.sourceforge.net/project/navalplan/NavalPlan/install_1.1.1.sql + $ wget -O install.sql http://downloads.sourceforge.net/project/libreplan/LibrePlan/install_1.1.1.sql * Create database structure:: - $ psql -h localhost -U navalplan -W navalplan < install.sql + $ psql -h localhost -U libreplan -W libreplan < install.sql * Download ``.war`` file from SourceForge.net:: - $ wget -O navalplan.war http://downloads.sourceforge.net/project/navalplan/NavalPlan/navalplan_1.1.1.war + $ wget -O libreplan.war http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.1.1.war -* Create a new file ``/etc/tomcat6/Catalina/localhost/navalplan.xml`` (file +* Create a new file ``/etc/tomcat6/Catalina/localhost/libreplan.xml`` (file name has to match with ``.war`` name) with database configuration for Tomcat 6:: - + url="jdbc:postgresql://localhost/libreplan" /> * Add link to Java JDBC driver for PostgreSQL in Tomcat6 libraries directory:: @@ -201,21 +201,21 @@ openSUSE * Copy war to Tomcat 6 web applications directory:: - # cp navalplan.war /srv/tomcat6/webapps/ + # cp libreplan.war /srv/tomcat6/webapps/ * Restart Tomcat 6:: # /etc/init.d/tomcat6 restart -* Go to http://localhost:8080/navalplan/ +* Go to http://localhost:8080/libreplan/ Logs ---- -Since *NavalPlan 1.1.1* log system is configured automatically creating a new +Since *LibrePlan 1.1.1* log system is configured automatically creating a new folder under ``/var/log/tomcat6/`` with ``.war`` name. For example: -``/var/log/tomcat6/navalplan.war``. +``/var/log/tomcat6/libreplan.war``. -Inside this new directory there will be two files (``navalplan.log`` and -``navalplan-error.log``) that will be rotated every day. +Inside this new directory there will be two files (``libreplan.log`` and +``libreplan-error.log``) that will be rotated every day. diff --git a/NEWS b/NEWS index 020caeb51..633026c36 100644 --- a/NEWS +++ b/NEWS @@ -12,7 +12,7 @@ labels were loaded and the persistence to disk failed. Other minor fixes included in this version: * Task Scheduling Status In Project report has been reviewed and fixed. -* Now NavalPlan does not depend on server language for translations of strings +* Now LibrePlan does not depend on server language for translations of strings in the business module. * Resource load chart is fixed for tasks finishing in the middle of a day. * Solved issue on Gantt saving due to transient resource allocations. @@ -185,7 +185,7 @@ Changes Version 1.1.0 (19 May 2011) --------------------------- -New major version of NavalPlan. Apart from a lot of bugfixing the main features +New major version of LibrePlan. Apart from a lot of bugfixing the main features included in this version are: * Fixed problem with WebKit based browsers. @@ -217,7 +217,7 @@ included in this version are: * Hierarchical criteria enforced. - Criteria in NavalPlan are like dynamic roles that resources can satisfy and + Criteria in LibrePlan are like dynamic roles that resources can satisfy and can be hierarchical. This means that one general criterion can include other more specific criteria inside. For instance, it is possible to configure the general criterion Engineer with two children like Electric Engineer and @@ -230,7 +230,7 @@ included in this version are: Generic allocation is the assignment based on criteria. You specify the set of criteria which must be satisfied by the workers who are able to do the - task and, after this, NavalPlan looks for them and selects the ones less + task and, after this, LibrePlan looks for them and selects the ones less loaded to be planned. The algorithm which selects the workers to be assigned to a task when @@ -268,7 +268,7 @@ included in this version are: * admin/admin. This user is the user with administration privileges. * user/user. This is a common user without administration privileges. * wswriter/wswriter. This user has write permissions to use then web - services operations which require modify or insert data in NavalPlan. + services operations which require modify or insert data in LibrePlan. * wsreader/wsreader. This user has read permissions to the use web services operations which only require read permissions. @@ -309,7 +309,7 @@ Notes If you are upgrading from any 1.0.x verion, you will need to manually execute on your database the SQL sentences from file: -``/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/1.1.0`` +``/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/1.1.0`` To get database access information review ``/etc/tomcat6/context.xml`` file. @@ -816,7 +816,7 @@ Changes * [Bug #898] Add column criterion type (worker or machine) in criterion types list. * [Bug #924] Call method useSchedulingDataFor for each order. -* NavalPlan exercises for formation course in Spanish in reStructuredText. +* LibrePlan exercises for formation course in Spanish in reStructuredText. * [doc] Added more sections to use case development guide. * [Bug #884] Show progress measurements list in reverse order. * [Bug #884] Sort progress measurements list in reverse order. @@ -837,7 +837,7 @@ Changes * [i18n] Updated translations. * [Bug #910] Change string 'Type resource assignation' to 'Resource allocation type' -* NavalPlan formation manual in spanish in reStructuredText. +* LibrePlan formation manual in spanish in reStructuredText. * [doc] Added information about interface in use case development guide. * [Bug #892] Rename labels in 'Overall progress' * [doc] Use case development guide. @@ -883,7 +883,7 @@ Changes hoursWorkedPerWorkerReport.jrxml. * Training material update * [doc] Added info about model and extract database data to report guide. -* [doc] First version of basic tutorial to create a new report on NavalPlan. +* [doc] First version of basic tutorial to create a new report on LibrePlan. * Added comment in main pom.xml to mark the point where bundle folders for reports are specified. * Give more priority to the resources already picked @@ -922,7 +922,7 @@ Changes * Apply validation annotation to the field * [Bug #871] The problem is due to receiving an empty list of tasks * [Bug #865] Fix bug -* [Bug #870] NavalPlan appears in English if browser is configured with es-es +* [Bug #870] LibrePlan appears in English if browser is configured with es-es * Fix bug create or edit resource should start on first tab * [Bug #864] S-curve changes the end date of a task * [Bug #868] It does not update the row of the order element correctly @@ -1064,7 +1064,7 @@ Changes * Make canWork rely on Capacity data * Use Capacity in BaseCalendar * Make consufing method private -* Updated NavalPlan license headers to 2011. +* Updated LibrePlan license headers to 2011. * Refactored components allocation_search and allocation_search_component * Added Resource.getCaptionFor() * Replaced method IResourceSearchModel.byLimiting(boolean) with .byResourceType @@ -1217,7 +1217,7 @@ Changes Version 1.0.5 (8 Apr 2011) -------------------------- -Last bugfixing version of NavalPlan for 1.0.x cycle, like in previous releases +Last bugfixing version of LibrePlan for 1.0.x cycle, like in previous releases it includes all the fixes done in the stable branch since 1.0.4. Among them we would like to highlight: @@ -1305,7 +1305,7 @@ Changes Version 1.0.4 (17 Mar 2011) --------------------------- -A new bugfixing version of NavalPlan, including a lot of bugs fixed during this +A new bugfixing version of LibrePlan, including a lot of bugs fixed during this month. * Resolved some stability problems appearing under certain circumstances. @@ -1368,7 +1368,7 @@ Changes * [Bug #898] Add column criterion type (worker or machine) in criterion types list. * [Bug #924] Call method useSchedulingDataFor for each order. -* NavalPlan exercises for formation course in Spanish in reStructuredText. +* LibrePlan exercises for formation course in Spanish in reStructuredText. * [Bug #884] Show progress measurements list in reverse order. * [Bug #884] Sort progress measurements list in reverse order. * [Bug #854] fix the labels in workingProgressPerTask report @@ -1388,7 +1388,7 @@ Changes * [i18n] Updated translations. * [Bug #910] Change string 'Type resource assignation' to 'Resource allocation type' -* NavalPlan formation manual in spanish in reStructuredText. +* LibrePlan formation manual in spanish in reStructuredText. * [Bug #892] Rename labels in 'Overall progress' * [Bug #903] Fix regression: creating a gap out of a LocalDate caused tasks may overlap due to loose of information about hour @@ -1444,7 +1444,7 @@ Changes * [Bug #855] Fix bug * Apply validation annotation to the field * [Bug #871] The problem is due to receiving an empty list of tasks -* [Bug #870] NavalPlan appears in English if browser is configured with es-es +* [Bug #870] LibrePlan appears in English if browser is configured with es-es * Fix bug create or edit resource should start on first tab * [Bug #864] S-curve changes the end date of a task * [Bug #868] It does not update the row of the order element correctly @@ -1568,7 +1568,7 @@ Notes If you are upgrading from any 1.0.x verion, you will need to manually execute on your database the SQL sentences from file: -``/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/1.0.0`` +``/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/1.0.0`` To get database access information review ``/etc/tomcat6/context.xml`` file. @@ -1638,7 +1638,7 @@ Changes Version 1.0.0 (07 Jan 2011) --------------------------- -This is the first stable release of *NavalPlan*, a free software web +This is the first stable release of *LibrePlan*, a free software web application for project management. Main features @@ -1653,7 +1653,7 @@ Main features * Overload resource allocation control. * Earned Value Management (EVM). * Cost analysis based on work reports. -* Integration with other *NavalPlan* instances and third-parties. +* Integration with other *LibrePlan* instances and third-parties. * Other functionalities: materials, quality forms, project templates, planning scenarios, multiple task progress measurement ... diff --git a/README b/README index 7795b7f45..e8a365c39 100644 --- a/README +++ b/README @@ -1,18 +1,18 @@ -NavalPlan +LibrePlan ========= Description ----------- -*NavalPlan* is a free software web application for project management. +*LibrePlan* is a free software web application for project management. -*NavalPlan* is a planning tool for users based on some concepts: company and +*LibrePlan* is a planning tool for users based on some concepts: company and multi-project overview, criteria assignments, tasks tagging, resources management, resource allocation (specific and generic), company load control, external integration, etc. -Although its name is clearly related to shipbuilding, *Navalplan* is a fully +Although its name is clearly related to shipbuilding, *LibrePlan* is a fully useful planning tool for any type of company whose workflow requires project and order administration and scheduling. @@ -28,7 +28,7 @@ Features * Overload resource allocation control. * Earned Value Management [3]_. * Cost analysis based on work reports. -* Integration with other *NavalPlan* instances and third-parties. +* Integration with other *LibrePlan* instances and third-parties. * Other functionalities: Materials, quality forms, project templates, planning scenarios, multiple task progress measurement ... @@ -74,32 +74,32 @@ Availability ------------ The cutting-edge version of this project is always available from the Git -repository at http://navalplan.git.sourceforge.net/. +repository at http://libreplan.git.sourceforge.net/. Released versions are available at -http://sourceforge.net/projects/navalplan/files. +http://sourceforge.net/projects/libreplan/files. Webpage ------- -You can find more information about *NavalPlan* at -http://www.navalplan.org/en/. +You can find more information about *LibrePlan* at +http://www.libreplan.org/en/. -For information related with *NavalPlan* development you can visit the wiki at -http://wiki.navalplan.org/. +For information related with *LibrePlan* development you can visit the wiki at +http://wiki.libreplan.org/. Reporting bugs -------------- -Please use the bug tracker to report bugs at http://bugs.navalplan.org/. +Please use the bug tracker to report bugs at http://bugs.libreplan.org/. License ------- -*NavalPlan* is released under the terms of the GNU Affero General Public +*LibrePlan* is released under the terms of the GNU Affero General Public License version 3 [4]_. Please read the ``COPYING`` file for details. diff --git a/UPDATE b/UPDATE index 2782779c8..7c98a8fa2 100644 --- a/UPDATE +++ b/UPDATE @@ -1,13 +1,13 @@ Update ====== -This is a guide about how to upgrade *NavalPlan* when a new version is released. +This is a guide about how to upgrade *LibrePlan* when a new version is released. If you want to know how to install the application ``INSTALL`` file. .. contents:: -NavalPlan automatic update +LibrePlan automatic update -------------------------- Ubuntu PPAs @@ -16,7 +16,7 @@ Ubuntu PPAs Instructions:: $ sudo apt-get update - $ sudo apt-get install navalplan + $ sudo apt-get install libreplan Debian packages @@ -26,18 +26,18 @@ Instructions: * Download the new package:: - $ wget http://downloads.sourceforge.net/project/navalplan/NavalPlan/navalplan_1.1.1-1_amd64.deb + $ wget http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.1.1-1_amd64.deb * Install package:: - # dpkg -i navalplan_1.1.1-1_amd64.deb + # dpkg -i libreplan_1.1.1-1_amd64.deb * Install new dependencies if needed:: # apt-get install -f -NavalPlan manual update +LibrePlan manual update ----------------------- Debian/Ubuntu @@ -48,32 +48,32 @@ Debian/Ubuntu # /etc/init.d/tomcat6 stop * Download database upgrade scripts from previous version. For example, if you - are upgrading from *NavalPlan 1.0.4* to *NavalPlan 1.1.1* you should download + are upgrading from *LibrePlan 1.0.4* to *LibrePlan 1.1.1* you should download ``upgrade_1.1.0.sql``:: - $ wget http://downloads.sourceforge.net/project/navalplan/NavalPlan/upgrade_1.1.0.sql + $ wget http://downloads.sourceforge.net/project/libreplan/LibrePlan/upgrade_1.1.0.sql * Upgrade database:: - $ psql -h localhost -U navalplan -W navalplan < upgrade_1.1.0.sql + $ psql -h localhost -U libreplan -W libreplan < upgrade_1.1.0.sql * Download ``.war`` file of new version from SourceForge.net:: - $ wget -O navalplan.war http://downloads.sourceforge.net/project/navalplan/NavalPlan/navalplan_1.1.1.war + $ wget -O libreplan.war http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.1.1.war * Backup current deployed application:: - # mv /var/lib/tomcat6/webapps/navalplan/ /tmp/ + # mv /var/lib/tomcat6/webapps/libreplan/ /tmp/ * Copy war to Tomcat 6 web applications directory:: - # cp navalplan.war /var/lib/tomcat6/webapps/ + # cp libreplan.war /var/lib/tomcat6/webapps/ * Start Tomcat 6:: # /etc/init.d/tomcat6 start -* Go to http://localhost:8080/navalplan/ +* Go to http://localhost:8080/libreplan/ openSUSE @@ -84,29 +84,29 @@ openSUSE # /etc/init.d/tomcat6 stop * Download database upgrade scripts from previous version. For example, if you - are upgrading from *NavalPlan 1.0.4* to *NavalPlan 1.1.1* you should download + are upgrading from *LibrePlan 1.0.4* to *LibrePlan 1.1.1* you should download ``upgrade_1.1.0.sql``:: - $ wget http://downloads.sourceforge.net/project/navalplan/NavalPlan/upgrade_1.1.0.sql + $ wget http://downloads.sourceforge.net/project/libreplan/LibrePlan/upgrade_1.1.0.sql * Upgrade database:: - $ psql -h localhost -U navalplan -W navalplan < upgrade_1.1.0.sql + $ psql -h localhost -U libreplan -W libreplan < upgrade_1.1.0.sql * Download ``.war`` file of new version from SourceForge.net:: - $ wget -O navalplan.war http://downloads.sourceforge.net/project/navalplan/NavalPlan/navalplan_1.1.1.war + $ wget -O libreplan.war http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.1.1.war * Backup current deployed application:: - # mv /srv/tomcat6/webapps/navalplan/ /tmp/ + # mv /srv/tomcat6/webapps/libreplan/ /tmp/ * Copy war to Tomcat 6 web applications directory:: - # cp navalplan.war /srv/tomcat6/webapps/ + # cp libreplan.war /srv/tomcat6/webapps/ * Start Tomcat 6:: # /etc/init.d/tomcat6 start -* Go to http://localhost:8080/navalplan/ +* Go to http://localhost:8080/libreplan/ diff --git a/contrib/cutycapt/debian/changelog b/contrib/cutycapt/debian/changelog index 7962ec1c6..3bd168eb3 100644 --- a/contrib/cutycapt/debian/changelog +++ b/contrib/cutycapt/debian/changelog @@ -6,7 +6,7 @@ cutycapt (20110107-2) lenny lucid maverick; urgency=low cutycapt (20110107-1) lenny squeeze intrepid karmic lucid maverick; urgency=low - * Updated to NavalPlan package naming. + * Updated to LibrePlan package naming. -- Manuel Rego Casasnovas Fri, 07 Jan 2011 10:35:17 +0100 diff --git a/debian/51libreplan.policy b/debian/51libreplan.policy new file mode 100644 index 000000000..59d5bdcbb --- /dev/null +++ b/debian/51libreplan.policy @@ -0,0 +1,6 @@ +grant codeBase "file:/var/lib/tomcat6/webapps/libreplan/-" { + permission java.security.AllPermission; +}; +grant codeBase "file:/var/lib/tomcat6/webapps/libreplan.war" { + permission java.security.AllPermission; +}; diff --git a/debian/51navalplan.policy b/debian/51navalplan.policy deleted file mode 100644 index eb1b8f11c..000000000 --- a/debian/51navalplan.policy +++ /dev/null @@ -1,6 +0,0 @@ -grant codeBase "file:/var/lib/tomcat6/webapps/navalplan/-" { - permission java.security.AllPermission; -}; -grant codeBase "file:/var/lib/tomcat6/webapps/navalplan.war" { - permission java.security.AllPermission; -}; diff --git a/debian/changelog b/debian/changelog index 086266821..c6ccdc5eb 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,4 @@ -navalplan (1.1.3-1) maverick; urgency=low +libreplan (1.1.3-1) maverick; urgency=low * Fixed important issue in Gantt view for big projects with labels. * Added bugs fixed from stable branch. @@ -6,7 +6,7 @@ navalplan (1.1.3-1) maverick; urgency=low -- Manuel Rego Casasnovas Fri, 12 Aug 2011 13:08:00 +0200 -navalplan (1.1.2-1) maverick; urgency=low +libreplan (1.1.2-1) maverick; urgency=low * Fixed critical bug that causes concurrency issues editing projects with labels. @@ -15,7 +15,7 @@ navalplan (1.1.2-1) maverick; urgency=low -- Manuel Rego Casasnovas Wed, 18 Jul 2011 13:23:00 +0200 -navalplan (1.1.1-1) maverick; urgency=low +libreplan (1.1.1-1) maverick; urgency=low * Changed dependency from OpenJDK to default-jdk or default-jre. * Added bugs fixed from stable branch. @@ -23,7 +23,7 @@ navalplan (1.1.1-1) maverick; urgency=low -- Manuel Rego Casasnovas Wed, 07 Jun 2011 09:15:00 +0200 -navalplan (1.1.0-1) maverick; urgency=low +libreplan (1.1.0-1) maverick; urgency=low * Removed unnecessary dependency with texlive-latex-recommended and pgf packages. @@ -33,35 +33,35 @@ navalplan (1.1.0-1) maverick; urgency=low -- Manuel Rego Casasnovas Wed, 19 Apr 2011 07:50:00 +0200 -navalplan (1.0.6-1) maverick; urgency=low +libreplan (1.0.6-1) maverick; urgency=low * Several important bugs fixed during 1.1 stabilization. * Released version 1.0.6. -- Manuel Rego Casasnovas Tue, 27 Apr 2011 11:49:00 +0200 -navalplan (1.0.5-1) maverick; urgency=low +libreplan (1.0.5-1) maverick; urgency=low * Added bugs fixed from stable branch. * Released version 1.0.5. -- Manuel Rego Casasnovas Fri, 08 Apr 2011 11:20:46 +0200 -navalplan (1.0.4-1) maverick; urgency=low +libreplan (1.0.4-1) maverick; urgency=low * Added bugs fixed from stable branch. * Released version 1.0.4. -- Manuel Rego Casasnovas Thu, 17 Mar 2011 12:27:47 +0100 -navalplan (1.0.3-1) maverick; urgency=low +libreplan (1.0.3-1) maverick; urgency=low * Added bugs fixed from stable branch. * Released version 1.0.3. -- Manuel Rego Casasnovas Mon, 14 Feb 2011 07:23:58 +0100 -navalplan (1.0.2-1) maverick; urgency=low +libreplan (1.0.2-1) maverick; urgency=low * Fixed database installation script. * Added bugfixed from stable branch. @@ -69,7 +69,7 @@ navalplan (1.0.2-1) maverick; urgency=low -- Manuel Rego Casasnovas Fri, 21 Jan 2011 12:07:33 +0100 -navalplan (1.0.1-1) maverick; urgency=low +libreplan (1.0.1-1) maverick; urgency=low * Added dependency with ttf-freefont on Debian package (needed for Jasper reports). @@ -78,7 +78,7 @@ navalplan (1.0.1-1) maverick; urgency=low -- Manuel Rego Casasnovas Fri, 14 Jan 2011 09:58:33 +0100 -navalplan (1.0.0-1) maverick; urgency=low +libreplan (1.0.0-1) maverick; urgency=low * Updated to upstream. Released version 1.0. * Added upgrade script needed to upgrade to version 1.0. @@ -86,33 +86,33 @@ navalplan (1.0.0-1) maverick; urgency=low -- Manuel Rego Casasnovas Tue, 07 Jan 2011 16:45:00 +0100 -navalplan (0.9.2-3) maverick; urgency=low +libreplan (0.9.2-3) maverick; urgency=low * Added missing postgresql dependency. -- Manuel Rego Casasnovas Tue, 07 Jan 2011 10:00:00 +0100 -navalplan (0.9.2-2) maverick; urgency=low +libreplan (0.9.2-2) maverick; urgency=low * Added postgresql-client dependency needed because of dbconfig. -- Manuel Rego Casasnovas Tue, 05 Jan 2011 16:12:00 +0100 -navalplan (0.9.2-1) maverick; urgency=low +libreplan (0.9.2-1) maverick; urgency=low * Updated to upstream. * Fixed issues on debian package. -- Manuel Rego Casasnovas Tue, 04 Jan 2011 15:58:19 +0100 -navalplan (0.9.1) maverick; urgency=low +libreplan (0.9.1) maverick; urgency=low * Updated to upstream. * Fixed problems with translations. -- Manuel Rego Casasnovas Thu, 23 Dec 2010 00:14:54 +0100 -navalplan (0.9.0) maverick; urgency=low +libreplan (0.9.0) maverick; urgency=low * Updated to upstream. * Fixed issues with context.xml file. @@ -121,19 +121,19 @@ navalplan (0.9.0) maverick; urgency=low -- Manuel Rego Casasnovas Tue, 21 Dec 2010 17:31:08 +0100 -navalplan (20100908) lucid; urgency=low +libreplan (20100908) lucid; urgency=low * Updated to upstream. -- Jose Maria Casanova Crespo (Chema) Wed, 8 Sep 2010 00:00:00 +0000 -navalplan (20100415) karmic; urgency=low +libreplan (20100415) karmic; urgency=low * Updated to upstream. -- Jose Maria Casanova Crespo (Chema) Thu, 15 Mar 2010 14:30:00 +0000 -navalplan (20100324) karmic; urgency=low +libreplan (20100324) karmic; urgency=low * Initial release. diff --git a/debian/control b/debian/control index 8da8fd4ea..033c1eff6 100644 --- a/debian/control +++ b/debian/control @@ -1,23 +1,23 @@ -Source: navalplan +Source: libreplan Section: web Priority: optional Maintainer: Adrian Perez Build-Depends: debhelper (>= 7.0.50), maven2, python-docutils, gettext (>= 0.17), default-jdk Standards-Version: 3.8.4 -Homepage: http://www.navalplan.org/en/ +Homepage: http://www.libreplan.org/en/ -Package: navalplan +Package: libreplan Architecture: any Depends: cutycapt, postgresql, postgresql-client, xvfb, dbconfig-common, ucf, tomcat6, default-jre-headless | default-jre, libpg-java, ttf-freefont, ${misc:Depends} Description: Web application for project management. - NavalPlan is a planning tool for users based on some concepts: company and + LibrePlan is a planning tool for users based on some concepts: company and multi-project overview, criteria assignments, tasks tagging, resources management, resource allocation (specific and generic), company load control, external integration, etc. . - Although its name is clearly related to shipbuilding, NavalPlan is a fully + Although its name is clearly related to shipbuilding, LibrePlan is a fully useful planning tool for any type of company whose workflow requires project and order administration and scheduling. diff --git a/debian/control.lucid b/debian/control.lucid index 0805769c5..ed05b300c 100644 --- a/debian/control.lucid +++ b/debian/control.lucid @@ -1,23 +1,23 @@ -Source: navalplan +Source: libreplan Section: web Priority: optional Maintainer: Adrian Perez Build-Depends: debhelper (>= 7.0.50), maven2, python-docutils, gettext (>= 0.17), texlive-latex-recommended, pgf, openjdk-6-jdk Standards-Version: 3.8.4 -Homepage: http://www.navalplan.org/en/ +Homepage: http://www.libreplan.org/en/ -Package: navalplan +Package: libreplan Architecture: any Depends: cutycapt, postgresql, postgresql-client, xvfb, dbconfig-common, ucf, tomcat6, openjdk-6-jre-headless | openjdk-6-jre, libpg-java, ttf-freefont, ${misc:Depends} Description: Web application for project management. - NavalPlan is a planning tool for users based on some concepts: company and + LibrePlan is a planning tool for users based on some concepts: company and multi-project overview, criteria assignments, tasks tagging, resources management, resource allocation (specific and generic), company load control, external integration, etc. . - Although its name is clearly related to shipbuilding, NavalPlan is a fully + Although its name is clearly related to shipbuilding, LibrePlan is a fully useful planning tool for any type of company whose workflow requires project and order administration and scheduling. diff --git a/debian/control.squeeze b/debian/control.squeeze index 0805769c5..ed05b300c 100644 --- a/debian/control.squeeze +++ b/debian/control.squeeze @@ -1,23 +1,23 @@ -Source: navalplan +Source: libreplan Section: web Priority: optional Maintainer: Adrian Perez Build-Depends: debhelper (>= 7.0.50), maven2, python-docutils, gettext (>= 0.17), texlive-latex-recommended, pgf, openjdk-6-jdk Standards-Version: 3.8.4 -Homepage: http://www.navalplan.org/en/ +Homepage: http://www.libreplan.org/en/ -Package: navalplan +Package: libreplan Architecture: any Depends: cutycapt, postgresql, postgresql-client, xvfb, dbconfig-common, ucf, tomcat6, openjdk-6-jre-headless | openjdk-6-jre, libpg-java, ttf-freefont, ${misc:Depends} Description: Web application for project management. - NavalPlan is a planning tool for users based on some concepts: company and + LibrePlan is a planning tool for users based on some concepts: company and multi-project overview, criteria assignments, tasks tagging, resources management, resource allocation (specific and generic), company load control, external integration, etc. . - Although its name is clearly related to shipbuilding, NavalPlan is a fully + Although its name is clearly related to shipbuilding, LibrePlan is a fully useful planning tool for any type of company whose workflow requires project and order administration and scheduling. diff --git a/debian/copyright b/debian/copyright index 917e0da73..1d9d49335 100644 --- a/debian/copyright +++ b/debian/copyright @@ -2,7 +2,7 @@ This package was debianized by Adrian Perez on Wed, 24 Mar 2010 16:35:00 +0000. -It was downloaded from https://sourceforge.net/projects/navalplan/ +It was downloaded from https://sourceforge.net/projects/libreplan/ Upstream Author: See AUTHORS file for details. @@ -13,7 +13,7 @@ Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e Copyright (C) 2010-2011 Igalia, S.L. -NavalPlan is licensed under the GNU Affero General Public License v3: +LibrePlan is licensed under the GNU Affero General Public License v3: This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by diff --git a/debian/navalplan.config b/debian/libreplan.config similarity index 88% rename from debian/navalplan.config rename to debian/libreplan.config index a5039301d..f29016e29 100644 --- a/debian/navalplan.config +++ b/debian/libreplan.config @@ -5,5 +5,5 @@ set -e if [ -r /usr/share/dbconfig-common/dpkg/config.pgsql ] ; then . /usr/share/dbconfig-common/dpkg/config.pgsql - dbc_go navalplan $@ + dbc_go libreplan $@ fi diff --git a/debian/libreplan.install b/debian/libreplan.install new file mode 100644 index 000000000..eb250a244 --- /dev/null +++ b/debian/libreplan.install @@ -0,0 +1,6 @@ +debian/tmp/var/lib/tomcat6/webapps/libreplan.war +debian/tmp/etc/tomcat6/policy.d/51libreplan.policy +debian/tmp/usr/share/dbconfig-common/data/libreplan/install/pgsql +debian/tmp/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/1.0.0 +debian/tmp/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/1.1.0 +debian/tmp/usr/share/tomcat6/lib/postgresql-jdbc3.jar diff --git a/debian/navalplan.postinst b/debian/libreplan.postinst similarity index 69% rename from debian/navalplan.postinst rename to debian/libreplan.postinst index 4f3cd9f1b..b4bc4d563 100644 --- a/debian/navalplan.postinst +++ b/debian/libreplan.postinst @@ -4,12 +4,12 @@ set -e . /usr/share/debconf/confmodule . /usr/share/dbconfig-common/dpkg/postinst.pgsql -dbc_go navalplan $@ +dbc_go libreplan $@ -if [[ $1 = configure && -r /etc/dbconfig-common/navalplan.conf ]] +if [[ $1 = configure && -r /etc/dbconfig-common/libreplan.conf ]] then - . /etc/dbconfig-common/navalplan.conf + . /etc/dbconfig-common/libreplan.conf if [ -z "${dbc_dbhost}" ] ; then database_host='localhost' @@ -17,11 +17,11 @@ then database_host=${dbc_dbhost} fi - echo "Adding navalplan Tomcat configuration bits" + echo "Adding libreplan Tomcat configuration bits" # Remove first (just in case!) - sed -i -e '/begin:navalplan/,/end:navalplan/d' /etc/tomcat6/policy.d/03catalina.policy - sed -i -e '/begin:navalplan/,/end:navalplan/d' /etc/tomcat6/context.xml + sed -i -e '/begin:libreplan/,/end:libreplan/d' /etc/tomcat6/policy.d/03catalina.policy + sed -i -e '/begin:libreplan/,/end:libreplan/d' /etc/tomcat6/context.xml # Modify /etc/tomcat6/context.xml # @@ -31,14 +31,14 @@ then while read -r line ; do if [[ ${line} = *\* ]] ; then cat <<-EOF - - + - + EOF fi echo "${line}" @@ -55,9 +55,9 @@ then while read -r line ; do echo "${line}" if [[ ${line} = *tomcat-juli.jar* ]] ; then - echo ' // begin:navalplan' - echo ' permission java.io.FilePermission "${catalina.base}${file.separator}webapps${file.separator}navalplanner-webapp${file.separator}WEB-INF${file.separator}classes${file.separator}logging.properties", "read";' - echo ' // end:navalplan' + echo ' // begin:libreplan' + echo ' permission java.io.FilePermission "${catalina.base}${file.separator}webapps${file.separator}libreplan-webapp${file.separator}WEB-INF${file.separator}classes${file.separator}logging.properties", "read";' + echo ' // end:libreplan' fi done < /etc/tomcat6/policy.d/03catalina.policy \ > /etc/tomcat6/policy.d/03catalina.policy.new @@ -77,8 +77,8 @@ if [ -x /etc/init.d/tomcat6 ] ; then fi fi -if [ -d /var/lib/tomcat6/webapps/navalplan/ ] ; then - rm -rf /var/lib/tomcat6/webapps/navalplan/ +if [ -d /var/lib/tomcat6/webapps/libreplan/ ] ; then + rm -rf /var/lib/tomcat6/webapps/libreplan/ fi if [ -x /etc/init.d/tomcat6 ] ; then diff --git a/debian/navalplan.postrm b/debian/libreplan.postrm similarity index 67% rename from debian/navalplan.postrm rename to debian/libreplan.postrm index eb515b542..e2488e9cc 100644 --- a/debian/navalplan.postrm +++ b/debian/libreplan.postrm @@ -5,13 +5,13 @@ set -e if [ -r /usr/share/dbconfig-common/dpkg/postinst.pgsql ] ; then . /usr/share/dbconfig-common/dpkg/postinst.pgsql - dbc_go navalplan $@ + dbc_go libreplan $@ fi if [[ $1 = purge ]] ; then - echo "Removing navalplan Tomcat configuration bits..." - sed -i -e '/begin:navalplan/,/end:navalplan/d' /etc/tomcat6/policy.d/03catalina.policy - sed -i -e '/begin:navalplan/,/end:navalplan/d' /etc/tomcat6/context.xml + echo "Removing libreplan Tomcat configuration bits..." + sed -i -e '/begin:libreplan/,/end:libreplan/d' /etc/tomcat6/policy.d/03catalina.policy + sed -i -e '/begin:libreplan/,/end:libreplan/d' /etc/tomcat6/context.xml fi #if [ -x /etc/init.d/tomcat5.5 ] ; then diff --git a/debian/navalplan.prerm b/debian/libreplan.prerm similarity index 93% rename from debian/navalplan.prerm rename to debian/libreplan.prerm index a40312566..8852218ba 100644 --- a/debian/navalplan.prerm +++ b/debian/libreplan.prerm @@ -5,7 +5,7 @@ set -e if [ -r /usr/share/dbconfig-common/dpkg/postinst.pgsql ] ; then . /usr/share/dbconfig-common/dpkg/postinst.pgsql - dbc_go navalplan $@ + dbc_go libreplan $@ fi if [ -L /usr/share/tomcat6/lib/postgresql-jdbc3.jar ] ; then diff --git a/debian/navalplan.install b/debian/navalplan.install deleted file mode 100644 index f69839ad4..000000000 --- a/debian/navalplan.install +++ /dev/null @@ -1,6 +0,0 @@ -debian/tmp/var/lib/tomcat6/webapps/navalplan.war -debian/tmp/etc/tomcat6/policy.d/51navalplan.policy -debian/tmp/usr/share/dbconfig-common/data/navalplan/install/pgsql -debian/tmp/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/1.0.0 -debian/tmp/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/1.1.0 -debian/tmp/usr/share/tomcat6/lib/postgresql-jdbc3.jar diff --git a/debian/rules b/debian/rules index fdc594d90..f5c040518 100755 --- a/debian/rules +++ b/debian/rules @@ -9,7 +9,7 @@ JAVA_HOME := /usr/lib/jvm/java-6-openjdk MAVEN_REPO := $(CURDIR)/debian/maven-repo MAVEN_OPTS := -Pprod,postgresql,-liquibase-update \ - -DdataSource.jndiName=java:comp/env/jdbc/navalplan-ds \ + -DdataSource.jndiName=java:comp/env/jdbc/libreplan-ds \ -Dmaven.test.skip=true -B \ -s $(CURDIR)/debian/maven-settings.xml @@ -67,23 +67,23 @@ install: $(call CMD,dh_clean -k) $(call CMD,dh_installdirs) # Copy SQL installation file - $(call CMD,mkdir -p $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/navalplan/install/) + $(call CMD,mkdir -p $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/libreplan/install/) $(call CMD,cp $(CURDIR)/scripts/database/install.sql \ - $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/navalplan/install/pgsql) + $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/libreplan/install/pgsql) # Commands to install arch-dependant stuff $(call CMD,mkdir -p $(CURDIR)/debian/tmp/var/lib/tomcat6/webapps/) - $(call CMD,cp $(CURDIR)/navalplanner-webapp/target/navalplanner-webapp.war \ - $(CURDIR)/debian/tmp/var/lib/tomcat6/webapps/navalplan.war) + $(call CMD,cp $(CURDIR)/libreplan-webapp/target/libreplan-webapp.war \ + $(CURDIR)/debian/tmp/var/lib/tomcat6/webapps/libreplan.war) # Copy SQL upgrade script for version 1.0.0 - $(call CMD,mkdir -p $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/) + $(call CMD,mkdir -p $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/) $(call CMD,cp $(CURDIR)/scripts/database/upgrade_1.0.0.sql \ - $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/1.0.0) + $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/1.0.0) # Copy SQL upgrade script for version 1.1.0 $(call CMD,cp $(CURDIR)/scripts/database/upgrade_1.1.0.sql \ - $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/navalplan/upgrade/pgsql/1.1.0) + $(CURDIR)/debian/tmp/usr/share/dbconfig-common/data/libreplan/upgrade/pgsql/1.1.0) # Install Policy file $(call CMD,mkdir -p $(CURDIR)/debian/tmp/etc/tomcat6/policy.d) - $(call CMD,cp $(CURDIR)/debian/51navalplan.policy \ + $(call CMD,cp $(CURDIR)/debian/51libreplan.policy \ $(CURDIR)/debian/tmp/etc/tomcat6/policy.d/) # Link Java PostgreSQL library $(call CMD,mkdir -p $(CURDIR)/debian/tmp/usr/share/tomcat6/lib) diff --git a/doc/src/technical/exercicio-navalplan.odt b/doc/src/technical/exercicio-libreplan.odt similarity index 100% rename from doc/src/technical/exercicio-navalplan.odt rename to doc/src/technical/exercicio-libreplan.odt diff --git a/doc/src/technical/guia-desenvolvemento/docinfo b/doc/src/technical/guia-desenvolvemento/docinfo index 52871856a..71fc3dfff 100644 --- a/doc/src/technical/guia-desenvolvemento/docinfo +++ b/doc/src/technical/guia-desenvolvemento/docinfo @@ -1,8 +1,8 @@ ################################## -NavalPlan: Guía de desenvolvemento +LibrePlan: Guía de desenvolvemento ################################## .. image:: images/logo.png :align: left -Esta é a guia de desenvolvemento da aplicación NavalPlan +Esta é a guia de desenvolvemento da aplicación LibrePlan diff --git a/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst b/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst index 7495f26c5..e370b0472 100644 --- a/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst +++ b/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst @@ -5,12 +5,12 @@ Guía de Arquitectura Arquitectura basada en capas ============================ -A aplicación Navalplan utiliza unha arquitectura de organización do código baseada en capas. Consiste en organizar o software nunha serie de divisións horizontais lóxicas. Estas divisións horizontais organízanse xerarquicamente de forman que descansa cada unha na capa que ten debaixo. Así ata a capa máis profunda. Nesta estruturación séguense os seguintes preceptos: +A aplicación LibrePlan utiliza unha arquitectura de organización do código baseada en capas. Consiste en organizar o software nunha serie de divisións horizontais lóxicas. Estas divisións horizontais organízanse xerarquicamente de forman que descansa cada unha na capa que ten debaixo. Así ata a capa máis profunda. Nesta estruturación séguense os seguintes preceptos: - Cada capa ten un conxunto de responsabilidades que corresponden a un determinado nivel de abstracción. - Unha capa ofrece servizos a capa de nivel superior. - Unha capa usa os servizos ofertados pola capa de nivel inferior. -As capas de que consta Navalplan son as seguintes: +As capas de que consta LibrePlan son as seguintes: - Capa de presentación - interfaz web. - Capa de interfaz servizos web. - Capa de lóxica de negocio. @@ -34,7 +34,7 @@ No patrón MVC distínguense 3 partes estruturais. operacións para actuar sobre eles. Na arquitectura está representado por clases que teñen xestionado o seu ciclo de vida a través do contedor de inxeción de dependencias que se usa *Spring framework*. Son clases conversacionais que rexistran o estado de interacción do usuario cunha determinada pantalla na que esté operando. - - **Controlador (Controller)**. O controlador é o compoñente software - materializado en Navalplan nunha clase de orientación a + - **Controlador (Controller)**. O controlador é o compoñente software - materializado en LibrePlan nunha clase de orientación a obxectos - que se encarga de atender as notificacións, peticións procedentes da vista e de solicitar ao modelo que realice as operacións pertinentes acordes coas ordes que o usuario emite ao programa a través da interfaz. @@ -44,8 +44,8 @@ Capa de interfaz de servizos web -------------------------------- A capa de servizos web é unha capa paralela a capa de interfaz web que ofrece servicios web REST para ofrecer funcionalidades de exportación/importación de datos dunha instalación da aplicación co exterior. Conténplanse dous tipos de comunicacións a través de servizos web: - - **Integración con outras aplicacións**. Quedarían englobados aquí os ERP que desexen interactuar con Navalplan. - - **Integración con outras instalacións de Navalplan**. Dúas instalacións de Navalplan en sendas empresas permiten interactuar + - **Integración con outras aplicacións**. Quedarían englobados aquí os ERP que desexen interactuar con LibrePlan. + - **Integración con outras instalacións de LibrePlan**. Dúas instalacións de LibrePlan en sendas empresas permiten interactuar para a subcontratación de pedidos e o reporte de avances dos mesmos. @@ -84,7 +84,7 @@ Spring Framework Spring Framework principalmente é un framework que proporciona un contedor de inxección de depedencias que permite a implementación do patrón de deseño IoC [2]_. -Resumidamente este principio de deseño permite desacoplar, é dicir, facer independentes, unhas parte dun programa de outras. Facendo independentes unhas partes de outras propicia que a arquitectura do programa permita cousas como cambiar unha determinada implementación por outra e que as cousas sigan a funcionar. Por exemplo, Navalplan permite a sustitución do ORM que implementa agora mesmo a persistencia, Hibernate, por outro ORM ou outra solución de almacenamento como usar directamente JDBC. +Resumidamente este principio de deseño permite desacoplar, é dicir, facer independentes, unhas parte dun programa de outras. Facendo independentes unhas partes de outras propicia que a arquitectura do programa permita cousas como cambiar unha determinada implementación por outra e que as cousas sigan a funcionar. Por exemplo, LibrePlan permite a sustitución do ORM que implementa agora mesmo a persistencia, Hibernate, por outro ORM ou outra solución de almacenamento como usar directamente JDBC. A través do contedor de inxección de dependencias tamén se permite xestionar o ciclo de vida dos obxectos que se crean recorrendo ao contedor - *beans* de Spring -. Por exemplo, pódese configurar que un *bean* teña ámbito *Singleton* [3]_ ou ben que se devolva unha nova instancia da clase do *bean* cada vez que se solicita unha nova referencia ao contedor. @@ -195,9 +195,9 @@ Relación das capas cos paquetes e módulos do proxecto Proxecto organizados en módulos: Definicion de modulo. - * Modulo navalplanner-business + * Modulo libreplan-business Concepto de servidor. Abarca as capas de loxica de negocio e persistencia. - * Modulo navalplanner-webapp. + * Modulo libreplan-webapp. Toda a interfaz e servicios conversacionais e servicios web. * Modulo ganttzk. Modulo para compoñentes ZK de diff --git a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst index dd0fee516..1054342db 100644 --- a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst +++ b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst @@ -18,7 +18,7 @@ Para comezar a traballar o primerio que terá que facer o desenvolvedor e descar :: - $ git clone git://navalplan.git.sourceforge.net/gitroot/navalplan/navalplan + $ git clone git://libreplan.git.sourceforge.net/gitroot/libreplan/libreplan Esto creará unha copia local de trabajo, para empezar a trabajar se recomienda la creación de una rama para cada caso de uso a desarrollar o nombre de la rama é recomendable que teña realación coa funcionalidade que implemente ou o número de bug que trata de solucionar, e logo nos movemos a traballar na rama cun checkout. @@ -152,7 +152,7 @@ A diferencia do resto dos usuarios debería descargar o repositorio da seguinte :: - $ git clone ssh://user@navalplan.git.sourceforge.net/gitroot/navalplan/navalplan + $ git clone ssh://user@libreplan.git.sourceforge.net/gitroot/libreplan/libreplan Esta forma de acceso permite un acceso de escritura ao repositorio: diff --git a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst index 4f1379c23..2412d88ce 100644 --- a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst +++ b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst @@ -230,7 +230,7 @@ _`Figura 14`: WorkerModelImpl::confirm. - + ... diff --git a/doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst b/doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst index 4556e7eeb..c90e02b6e 100644 --- a/doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst +++ b/doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst @@ -1,16 +1,16 @@ -NavalPlan: Guía de integración +LibrePlan: Guía de integración ############################## -A guía de integración de NavalPlan detalla as posibilidades existentes para a integración entre aplicacións co software NavalPlan. +A guía de integración de LibrePlan detalla as posibilidades existentes para a integración entre aplicacións co software LibrePlan. -As funcionalidades de integración da ferramenta para a Xestión da Producción permitirán a compartición de datos entre as distintas ferramentas existentes en cada empresa. NavalPlan define unha serie de formatos de intercambio de información empregando a sintaxe XML. A descrición das interfaces e formatos de intercambio son totalmente abertos e está dispoñible a súa implementación para incorporar novas posibilidades de integración se fose necesario. +As funcionalidades de integración da ferramenta para a Xestión da Producción permitirán a compartición de datos entre as distintas ferramentas existentes en cada empresa. LibrePlan define unha serie de formatos de intercambio de información empregando a sintaxe XML. A descrición das interfaces e formatos de intercambio son totalmente abertos e está dispoñible a súa implementación para incorporar novas posibilidades de integración se fose necesario. Visión Global ============= -NavalPlan é unha aplicación que ten coma núcleo de funcionalidades a xestión da planificación e control dunha empresa. NavalPlan traballa cun conxunto de datos enfocado a xestión de recursos para a realización de tarefas permitindo a súa planificación e control. Aínda que NavalPlan permite xestionar o proceso de forma autónoma é necesario provelo de mecanismos de intercambio que permitan a incorporación de información recollida por outras aplicacións xa existentes nas empresas usuarias de NavalPlan. +LibrePlan é unha aplicación que ten coma núcleo de funcionalidades a xestión da planificación e control dunha empresa. LibrePlan traballa cun conxunto de datos enfocado a xestión de recursos para a realización de tarefas permitindo a súa planificación e control. Aínda que LibrePlan permite xestionar o proceso de forma autónoma é necesario provelo de mecanismos de intercambio que permitan a incorporación de información recollida por outras aplicacións xa existentes nas empresas usuarias de LibrePlan. As empresas que teñen unha certa implantación de sistemas de xestión deberían permitir incorporar a información dos mesmos para facer máis rico e sinxelo o traballo co planificador. As entidades que teñen unha utilidade fóra do planificador son: @@ -20,28 +20,28 @@ As empresas que teñen unha certa implantación de sistemas de xestión debería Estes elementos son empregados directamente no planificador, xa que os pedidos organízanse en tarefas, que son asignadas a recursos e logo a súa execución é controlada a través dos partes de traballo e a súa vez faise un análise de custos. -NavalPlan permite a integración en dous escenarios: +LibrePlan permite a integración en dous escenarios: - * Integración con outras aplicacións: permitindo a incorporación de datos de programas desenvoltos por terceiros. Isto será posible empregando as Interfaces Públicas da Aplicación (API) dispoñibles. A API de NavalPlan permite a interacción coas seguintes entidades propias: recursos, pedidos e partes de traballo, aínda que incorporan outras entidades de interese coma materiais, etiquetas, criterios, categorías de custo e tipos de horas. - * Integración con outras instancias de NavalPlan: permitindo operacións que deixen compartir información entre distintas empresas centrándose no proceso de subcontratación e reporte de avances do subcontratista. + * Integración con outras aplicacións: permitindo a incorporación de datos de programas desenvoltos por terceiros. Isto será posible empregando as Interfaces Públicas da Aplicación (API) dispoñibles. A API de LibrePlan permite a interacción coas seguintes entidades propias: recursos, pedidos e partes de traballo, aínda que incorporan outras entidades de interese coma materiais, etiquetas, criterios, categorías de custo e tipos de horas. + * Integración con outras instancias de LibrePlan: permitindo operacións que deixen compartir información entre distintas empresas centrándose no proceso de subcontratación e reporte de avances do subcontratista. Integración con outras aplicacións da propia empresa ---------------------------------------------------- -NavalPlan permite a integración con outras aplicacións, NavalPlan poderá incorporar información procedente de outras aplicacións empregando un formato de intercambio común que será recibido por un servizo web que permitirá realizar actualizacións de datos ao longo do tempo. +LibrePlan permite a integración con outras aplicacións, LibrePlan poderá incorporar información procedente de outras aplicacións empregando un formato de intercambio común que será recibido por un servizo web que permitirá realizar actualizacións de datos ao longo do tempo. -Esta integración deberá ser configurada mediante a habilitación dun usuario que terá permiso de acceso para cada un dos servizos que é de interese integrar, as aplicacións poderán chamar aos servizos empregando o nome de usuario e contrasinal e NavalPlan procesará a incorporación dos datos enviados. En caso de que ocorran erros na incorporación de datos na resposta da petición incorporarase a información dispoñible sobre o erro. +Esta integración deberá ser configurada mediante a habilitación dun usuario que terá permiso de acceso para cada un dos servizos que é de interese integrar, as aplicacións poderán chamar aos servizos empregando o nome de usuario e contrasinal e LibrePlan procesará a incorporación dos datos enviados. En caso de que ocorran erros na incorporación de datos na resposta da petición incorporarase a información dispoñible sobre o erro. A integración dentro da empresa permite unha integración forte con distintas aplicacións que poderán chamar en calquera momento aos servizos web para a actualización de datos. -Integración entre aplicacións NavalPlan de distintas empresas +Integración entre aplicacións LibrePlan de distintas empresas ------------------------------------------------------------- -NavalPlan ten sido concibido coma un software que permita a realación con distintas empresas que empreguen a aplicación. O escenario principal de colaboración entre empresas é a contratación entre as mesmas, dentro do proceso de planificación é normal a situación que varias empresas colaboren nun mesmo proxecto sendo unha a contratista principal e outras subcontratistas desta. +LibrePlan ten sido concibido coma un software que permita a realación con distintas empresas que empreguen a aplicación. O escenario principal de colaboración entre empresas é a contratación entre as mesmas, dentro do proceso de planificación é normal a situación que varias empresas colaboren nun mesmo proxecto sendo unha a contratista principal e outras subcontratistas desta. -NavalPlan ten desenvolto un sistema de intercambio de información que permite remitir a información das tarefas a subcontratar a outras empresas e recibir os reportes de avance dos proxectos subcontratados. +LibrePlan ten desenvolto un sistema de intercambio de información que permite remitir a información das tarefas a subcontratar a outras empresas e recibir os reportes de avance dos proxectos subcontratados. Esta integración a nivel aplicación precisa da existencia de usuarios cruzados entre as empresas subcontratante e subcontratista. Esta configuración permitirá que as aplicacións se poidan comunicar a información en tempo real. @@ -61,10 +61,10 @@ Un *servizo web* defínese como un mecanismo de comunicación que se establece e As razóns que levaron á elección de servizos web como vehículo de comunicación para levar a cabo a integración son as seguintes: - * Por unha banda, os servizos web utilizan o protocolo HTTP como transporte, que é o que usa a WWW. Debido a que practicamente en todas as redes de ordenadores está permitido o acceso á WWW, os firewalls das corporacións non filtran o porto no que se serve a web, e de forma transparente a integración de NavalPlan con outra instalación do programa en outra empresa ou con outras aplicacións dentro da compañía funcionaría. + * Por unha banda, os servizos web utilizan o protocolo HTTP como transporte, que é o que usa a WWW. Debido a que practicamente en todas as redes de ordenadores está permitido o acceso á WWW, os firewalls das corporacións non filtran o porto no que se serve a web, e de forma transparente a integración de LibrePlan con outra instalación do programa en outra empresa ou con outras aplicacións dentro da compañía funcionaría. * Permiten a definición de mensaxes estruturados en XML - non son protocolos binarios de comunicación - de forma que é sinxelo entender as mensaxes de intercambio se o XML se define de forma acorde ao *modelo de dominio*. * É unha tecnoloxía amplamente probada. - * É independente da linguaxe de programación. Isto permite que aínda que NavalPlan está desenvolvido utilizando a plataforma Java póidanse realizar clientes en distintas tecnoloxías como .NET, C, C++ maximizando as capacidades de integración e facilitándoa. + * É independente da linguaxe de programación. Isto permite que aínda que LibrePlan está desenvolvido utilizando a plataforma Java póidanse realizar clientes en distintas tecnoloxías como .NET, C, C++ maximizando as capacidades de integración e facilitándoa. Dentro dos servizos web existen dous grandes subtipos: Os servizos web baseados en *SOAP* e os servizos web *REST*. @@ -72,17 +72,17 @@ A grandes trazos os servizos web baseados en *SOAP* utilizan como corpo das mens Os servizos web REST (REpresentational State Transfer) usan as operacións do protocolo HTTP (POST, PUT, DELETE e GET) para especificar parte das operacións e non poñen restricións acerca do corpo das mensaxes. Poden ser XML ou non e, se son XML, non teñen que cinguirse ao estándar *SOAP*. -En NavalPlan os servizos web nos que se baseará a integración serán servizos *REST*. As razóns da elección de servizos REST son as seguintes: +En LibrePlan os servizos web nos que se baseará a integración serán servizos *REST*. As razóns da elección de servizos REST son as seguintes: - * Son máis sinxelos de implementar que os servizos *SOAP*. Isto facilita aos usuarios que queiran integrarse con NavalPlan o proceso, xa que o desenvolvemento e a depuración é máis sinxela. + * Son máis sinxelos de implementar que os servizos *SOAP*. Isto facilita aos usuarios que queiran integrarse con LibrePlan o proceso, xa que o desenvolvemento e a depuración é máis sinxela. * Unicamente son máis directos de implementar os servizos web *SOAP* se se utilizan ferramentas automáticas (que existen en linguaxes como Java ou .NET) que a partir da descrición dos servizos (WSDL) son capaces de xerar os clientes. Agora ben, esta vantaxe descartouse para a elección do tipo de servizos web a implementar porque se quere que, no caso de que non exista integración automática e os XML de intercambio de datos se xeren a man ou ben a partir dunha base de datos pero sen ter que programarse o cliente *SOAP*, esta integración siga sendo posible. -Invocar un servizo web REST de NavalPlan será tan sinxelo como cun cliente HTTP (como pode ser simplemente o navegador para algunhas operacións) invocar unha URL. +Invocar un servizo web REST de LibrePlan será tan sinxelo como cun cliente HTTP (como pode ser simplemente o navegador para algunhas operacións) invocar unha URL. Seguridade ---------- -Os servizos web REST de que constará NavalPlan para a integración contemplan un soporte de seguridade. A seguridade trátase en 3 dimensións: +Os servizos web REST de que constará LibrePlan para a integración contemplan un soporte de seguridade. A seguridade trátase en 3 dimensións: * Seguridade da comunicación. * Autenticación do cliente. @@ -92,9 +92,9 @@ Os servizos web REST de que constará NavalPlan para a integración contemplan u Seguridade da comunicación ~~~~~~~~~~~~~~~~~~~~~~~~~~ -A seguridade da comunicación refírese a garantir que as mensaxes que se intercambian entre unha instalación de NavalPlan e os seus clientes (que pode ser outra aplicación ou outra instalación de NavalPlan realizada noutra compañía) sexan confidencias entre os dous extremos da comunicación. Quere dicir isto que, como pode que atravesen redes públicas - integración a través de Internet -, están suxeitas a poder ser examinados por todas as persoas ou axentes que teñan acceso ao medio. Para evitar, por tanto, que ao examinar o medio se obteña información privada das empresas que manteñen a comunicación con NavalPlan este proporciona un mecanismo de seguridade. +A seguridade da comunicación refírese a garantir que as mensaxes que se intercambian entre unha instalación de LibrePlan e os seus clientes (que pode ser outra aplicación ou outra instalación de LibrePlan realizada noutra compañía) sexan confidencias entre os dous extremos da comunicación. Quere dicir isto que, como pode que atravesen redes públicas - integración a través de Internet -, están suxeitas a poder ser examinados por todas as persoas ou axentes que teñan acceso ao medio. Para evitar, por tanto, que ao examinar o medio se obteña información privada das empresas que manteñen a comunicación con LibrePlan este proporciona un mecanismo de seguridade. -A seguridade consiste na posibilidade de servir cifrados os datos e a elección feita para realizar o cifrado é servir os servizos web por HTTPS (HTTP Secure) en lugar de por HTTP. HTTPS é a combinación de HTTP con SSL. Con SSL conséguese por una parte garantir a identidade do servidor NavalPlan e, por outra banda, cifrar a comunicación entre o servidor e o cliente. +A seguridade consiste na posibilidade de servir cifrados os datos e a elección feita para realizar o cifrado é servir os servizos web por HTTPS (HTTP Secure) en lugar de por HTTP. HTTPS é a combinación de HTTP con SSL. Con SSL conséguese por una parte garantir a identidade do servidor LibrePlan e, por outra banda, cifrar a comunicación entre o servidor e o cliente. Servir os servizos web con HTTPS pódese facer tanto dende o contedor de Servlets necesario para servir a aplicación (Apache Tomcat, Jetty) como se se serve detrás dun proxy que realice o cifrado por HTTPS (por exemplo detrás dun servidor web Apache). En calquera caso, será necesario que a empresa posúa un *certificado público* que permita servir por HTTPS os servizos web e/ou a aplicación. @@ -104,9 +104,9 @@ Autenticación do cliente O proceso de autenticación consiste en determinar quen é a persoa ou entidade que quere efectuar unha operación ofrecida por un servizo web. -A aplicación NavalPlan conta con autenticación a través da súa interface web. Está desenvolvido un módulo de usuarios que permite a alta, baixa de usuarios e a configuración dos permisos que poden posuír. Existe un conxunto predefinido de roles e estes roles se poden outorgar/denegar aos diferentes usuarios. Un rol permite realizar un determinado conxunto de operacións. +A aplicación LibrePlan conta con autenticación a través da súa interface web. Está desenvolvido un módulo de usuarios que permite a alta, baixa de usuarios e a configuración dos permisos que poden posuír. Existe un conxunto predefinido de roles e estes roles se poden outorgar/denegar aos diferentes usuarios. Un rol permite realizar un determinado conxunto de operacións. -Para a autenticación nos servizos web proponse reutilizar o sistema de usuarios de forma que para que o servidor vaia a proporcionar unha resposta haberá un paso de autenticar ao peticionario. Por tanto as aplicacións que se desexen integrar con NavalPlan terán que ter creadas na aplicación un usuario coas credencias adecuadas para invocar as operacións desexadas. +Para a autenticación nos servizos web proponse reutilizar o sistema de usuarios de forma que para que o servidor vaia a proporcionar unha resposta haberá un paso de autenticar ao peticionario. Por tanto as aplicacións que se desexen integrar con LibrePlan terán que ter creadas na aplicación un usuario coas credencias adecuadas para invocar as operacións desexadas. Para identificar o peticionario vaise usar a autenticación Basic Access Authentication HTTP. Con este método de autenticación pode pasarse un usuario/contrasinal ao servidor web. Pásase cunha cabeceira na mensaxe HTTP. O formato é o seguinte: @@ -118,7 +118,7 @@ A codificación base64 unicamente é para ocultar o usuario:contrasinal da vista Autorización do cliente respecto á operación invocada ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Unha vez se é capaz de identificar o peticionario da operación do servizo web, é necesario autorizalo ou denegarlle o acceso. Na aplicación web que forma parte de NavalPlan a autorización faise utilizando o framework *Spring Security*. A través deste framework é posible de forma declarativa esixir a posesión de un rol para acceder a unha determinada operación. +Unha vez se é capaz de identificar o peticionario da operación do servizo web, é necesario autorizalo ou denegarlle o acceso. Na aplicación web que forma parte de LibrePlan a autorización faise utilizando o framework *Spring Security*. A través deste framework é posible de forma declarativa esixir a posesión de un rol para acceder a unha determinada operación. Os servizos web se identifican por URL e método HTTP. Exemplos diso son: @@ -139,7 +139,7 @@ Desta maneira garántese que o usuario peticionario do servizo ten as credencias Conceptos xerais e políticas globais ==================================== -Nesta sección detállase unha serie de asuncións e requisitos que se deberán cumprir para ter unha boa integración con NavalPlan. Nesta sección se tratarán as seguintes temáticas: +Nesta sección detállase unha serie de asuncións e requisitos que se deberán cumprir para ter unha boa integración con LibrePlan. Nesta sección se tratarán as seguintes temáticas: * Codificación das entidades * Comportamentos das altas e actualizacións @@ -149,21 +149,21 @@ Nesta sección detállase unha serie de asuncións e requisitos que se deberán Codificación das entidades -------------------------- -En todos os fluxos de integración de entidades, cada un dos obxectos que se transmiten dunha aplicación a outra terán unha codificación. Desta forma un obxecto terá un identificador alfanumérico que o identifique tanto na aplicación de NavalPlan coma no resto das aplicacións que se integren. +En todos os fluxos de integración de entidades, cada un dos obxectos que se transmiten dunha aplicación a outra terán unha codificación. Desta forma un obxecto terá un identificador alfanumérico que o identifique tanto na aplicación de LibrePlan coma no resto das aplicacións que se integren. -As entidades que participan na integración terán un atributo *code*, no que se gardará a codificación. A existencia deste código e o seu mantemento é necesario para a correcta integración. O código debe ser único por entidade. Aínda que as entidades suxeitas a integración con outras aplicacións teñen este atributo *code* único dentro de NavalPlan para todas as entidades utilizarase un identificador subrogado autoxerado polo framework de persistencia. +As entidades que participan na integración terán un atributo *code*, no que se gardará a codificación. A existencia deste código e o seu mantemento é necesario para a correcta integración. O código debe ser único por entidade. Aínda que as entidades suxeitas a integración con outras aplicacións teñen este atributo *code* único dentro de LibrePlan para todas as entidades utilizarase un identificador subrogado autoxerado polo framework de persistencia. -NavalPlan á hora de comunicarse con outras aplicacións recibirá os obxectos e cotexará a existencia dentro do sistema de obxectos de NavalPlan. Se se recibe un obxecto cunha codificación existente entendese que é unha actualización do mesmo, se o obxecto que se recibe non existe no sistema NavalPlan darao de alta. +LibrePlan á hora de comunicarse con outras aplicacións recibirá os obxectos e cotexará a existencia dentro do sistema de obxectos de LibrePlan. Se se recibe un obxecto cunha codificación existente entendese que é unha actualización do mesmo, se o obxecto que se recibe non existe no sistema LibrePlan darao de alta. No caso de que se incorporen entidades con referencias a outras entidades entón na importación comprobarase se existe esta entidade referenciada e se non existe darase un erro. Un exemplo disto sería cando se realice a importación dun traballador e se fai referencia ao calendario que se lle quere asignar. Se non existe, indicarase que non se atopa a instancia. -A incorporación mediante ficheiro XML supón a introdución dunha secuencia de _ítems_ que se van a ir procesando secuencialmente. Esta secuencia de ítems estará formada polas entidades que se incorporan a aplicación. Para identificar as entidades que se transmiten NavalPlan empregará unha codificación baseada en dous parámetros: +A incorporación mediante ficheiro XML supón a introdución dunha secuencia de _ítems_ que se van a ir procesando secuencialmente. Esta secuencia de ítems estará formada polas entidades que se incorporan a aplicación. Para identificar as entidades que se transmiten LibrePlan empregará unha codificación baseada en dous parámetros: * A posición da instancia no XML. Chamarase *num_item* * A codificación baseada no código. Chamarase *code* * O tipo de entidade da instancia. Chamarase *entity-type* -No caso de que unha instancia referencie a unha terceira da cal non se dispón do código dado de alta no sistema, NavalPlan reportará un erro de importación indicando o num_item e a codificación da entidade que produciu o erro de importación. +No caso de que unha instancia referencie a unha terceira da cal non se dispón do código dado de alta no sistema, LibrePlan reportará un erro de importación indicando o num_item e a codificación da entidade que produciu o erro de importación. Resumo da codificación da identificación das instancias: @@ -175,16 +175,16 @@ Resumo da codificación da identificación das instancias: Espazo de nomes e codificación na relación con terceiras empresas ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -No caso de integración de servizos dentro da mesma empresa partimos da existencia e control dunha unicidade de código dentro da organización. Iso non se pode presupoñer cando nos referimos á situación de relación entre dúas empresas. Nese caso NavalPlan manterá unha referencia dobre sobre as instancias de entidades que son compartidas entre dúas organizacións. +No caso de integración de servizos dentro da mesma empresa partimos da existencia e control dunha unicidade de código dentro da organización. Iso non se pode presupoñer cando nos referimos á situación de relación entre dúas empresas. Nese caso LibrePlan manterá unha referencia dobre sobre as instancias de entidades que son compartidas entre dúas organizacións. -NavalPlan respectará a codificación das entidades da empresa subcontratante e será a empresa subcontratista a que manteña ao longo de todas as comunicacións a referencia ás entidades reportadas pola empresa subcontratante. Esta relación manterase no caso das entidades relacionadas cos pedidos como é o caso de Order e OrderElement. Nesas entidades incorporarase un novo atributo *external-code* que fará referencia ao atributo *code* da entidade contratante. +LibrePlan respectará a codificación das entidades da empresa subcontratante e será a empresa subcontratista a que manteña ao longo de todas as comunicacións a referencia ás entidades reportadas pola empresa subcontratante. Esta relación manterase no caso das entidades relacionadas cos pedidos como é o caso de Order e OrderElement. Nesas entidades incorporarase un novo atributo *external-code* que fará referencia ao atributo *code* da entidade contratante. Internamente a empresa subcontratista traballará coa súa codificación propia no atributo *code* que será empregada na interacción coas outras aplicacións da propia empresa. Comportamentos das altas e actualizacións ----------------------------------------- -A aplicación NavalPlan permitirá realizar unha alta a través de bloques de entidades. A semántica que se adoptará nestas incorporación de conxuntos de entidades será a seguinte. Realmente a operación non é unha alta senón que vai a ser unha alta ou modificación. Isto significa que cando se leva a cabo a incorporación se segue o seguinte algoritmo: +A aplicación LibrePlan permitirá realizar unha alta a través de bloques de entidades. A semántica que se adoptará nestas incorporación de conxuntos de entidades será a seguinte. Realmente a operación non é unha alta senón que vai a ser unha alta ou modificación. Isto significa que cando se leva a cabo a incorporación se segue o seguinte algoritmo: 1. Compróbase se existe a entidade do bloque a inserir. #. Se non existe a entidade, entón procédese a levar a cabo a alta. @@ -215,14 +215,14 @@ As mensaxes de resposta HTTP conteñen unha liña que se coñece como liña de e Como se pode apreciar existe un campo que é o código de estado, *Status-Code*. O código de estado é un numero de 3 díxitos que se usa para indicar como foi satisfeita a petición por parte do servidor web. Existen un conxunto de estados predefinidos que indican causas comúns que poden acontecer cando se invoca unha URL por parte dun cliente. -NavalPlan vai a facer o seguinte uso dos códigos de estado das respostas HTTP: +LibrePlan vai a facer o seguinte uso dos códigos de estado das respostas HTTP: 1. *200 OK*. Se a petición é servida correctamente. Os erros lóxicos froito dos datos de entrada do servizo tamén se reportarán mediante este código. Xa que o cliente poderá procesalos para analizar as causas dos erros. - #. *404 Not Found*. Este código de estado non se vai a devolver por parte de ningún servizo web de NavalPlan. Será devolto unicamente polo contedor de servlets se o cliente invoca unha URL que non se corresponde con ningún dos servizos publicados. - #. *403 Access is denied*. Este código de estado será devolto por NavalPlan cando a autenticación do usuario é correcta no sistema de usuarios da aplicación pero non ten permiso para executar o servizo que se está solicitando. - #. *401 Bad credentials*. É utilizado na resposta por NavalPlan para indicar que a autenticación é incorrecta. Quere dicir o anterior que non existe un usuario/contrasinal válido. + #. *404 Not Found*. Este código de estado non se vai a devolver por parte de ningún servizo web de LibrePlan. Será devolto unicamente polo contedor de servlets se o cliente invoca unha URL que non se corresponde con ningún dos servizos publicados. + #. *403 Access is denied*. Este código de estado será devolto por LibrePlan cando a autenticación do usuario é correcta no sistema de usuarios da aplicación pero non ten permiso para executar o servizo que se está solicitando. + #. *401 Bad credentials*. É utilizado na resposta por LibrePlan para indicar que a autenticación é incorrecta. Quere dicir o anterior que non existe un usuario/contrasinal válido. #. *500 Internal Server Error*. Devólvese este código de estado sempre que se produce algún erro provocado por unha excepción que provoque a finalización do fío de execución (thread) no servidor que atende a petición do servizo. - #. *400 Bad Request*. Darase este erro cando a validación do corpo da petición XML por parte do servizo web de NavalPlan non sexa correcta por non axustarse ao esquema XML que describe o servizo. + #. *400 Bad Request*. Darase este erro cando a validación do corpo da petición XML por parte do servizo web de LibrePlan non sexa correcta por non axustarse ao esquema XML que describe o servizo. Erros que provocan a finalización do fío de execución (thread) @@ -233,7 +233,7 @@ Se existe un erro de programación que xorde froito da invocación dun servizo n :: - @@ -241,17 +241,17 @@ Se existe un erro de programación que xorde froito da invocación dun servizo n Dentro de ** irá a pila de execución de chamadas do programa ata chegar a función que desencadeou o problema. -Cando se produce un erro deste tipo a entidade que estea realizando a integración podería crear unha incidencia no sistema de xestión de erros describindo a situación que levou a aparición do erro e incluíndo o stack-trace devolto polo servizo web para facilitar a solución do erro pola comunidade de NavalPlan. +Cando se produce un erro deste tipo a entidade que estea realizando a integración podería crear unha incidencia no sistema de xestión de erros describindo a situación que levou a aparición do erro e incluíndo o stack-trace devolto polo servizo web para facilitar a solución do erro pola comunidade de LibrePlan. Erros lóxicos ~~~~~~~~~~~~~ -Os erros lóxicos son erros que non son debidos a un defecto na aplicación NavalPlan senón que son debidos a dúas posibles causas: +Os erros lóxicos son erros que non son debidos a un defecto na aplicación LibrePlan senón que son debidos a dúas posibles causas: - * Os datos que se teñen na base de datos de NavalPlan non son compatibles cos datos de entrada da petición. + * Os datos que se teñen na base de datos de LibrePlan non son compatibles cos datos de entrada da petición. * Os datos de entrada para a operación solicitada no servizo web non son correctos. -Cando se producen erros lóxicos van a ser catalogados polo equipo de desenvolvemento de NavalPlan en dous posibles tipos: +Cando se producen erros lóxicos van a ser catalogados polo equipo de desenvolvemento de LibrePlan en dous posibles tipos: 1. Erros recuperables. Os erros recuperables son aqueles para os que os desenvolvedores da integración do cliente poden decidir intentar realizar unha recuperación automática do erro. #. Erros non recuperables. Os erros non recuperables son aqueles para os que non se pode implementar ningún mecanismo automático de solución do problema e o único camiño e a intervención humana para a solución dos problemas detectados. @@ -278,7 +278,7 @@ Cada erro recuperable indícase a través da etiqueta ** e ca A descrición dun ** é a seguinte: - * Atributo *error-code*. No atributo *error-code* irá un código de erro interno definido en NavalPlan. Será un número e existirá unha táboa de códigos de erros recuperables en NavalPlan que permitirán aos integradores implementar unha solución recuperable adecuada a cada código de erro. + * Atributo *error-code*. No atributo *error-code* irá un código de erro interno definido en LibrePlan. Será un número e existirá unha táboa de códigos de erros recuperables en LibrePlan que permitirán aos integradores implementar unha solución recuperable adecuada a cada código de erro. * Atributo *message*. Aquí indicarase unha descrición do erro. * Etiqueta **. Pode haber varias etiquetas deste tipo que son usadas para proporcionar datos que poden ser necesarios con dous atributos cada unha: @@ -299,7 +299,7 @@ O framework que se utiliza para a implementación dos servizos web é Apache CXF Os documentos XML Schema son un estándar da W3C que permite especificar a estrutura e formato dos documentos XML. Poden ser utilizados para validar se un determinado XML se axusta a un determinado esquema e así determinar se hai algún erro. -Xa que para os servizos web de NavalPlan van estar dispoñibles os XML Schema dos mesmos, estes poderán ser utilizados polos integradores de aplicacións con NavalPlan para validar que xeran os XML de intercambio correctos. +Xa que para os servizos web de LibrePlan van estar dispoñibles os XML Schema dos mesmos, estes poderán ser utilizados polos integradores de aplicacións con LibrePlan para validar que xeran os XML de intercambio correctos. Tamén se implementará a través de CXF unha validación do XML entrante no corpo das mensaxes HTTP de invocación dos servizos web por parte dos clientes. Por tanto, se validará se o XML contra o esquema XML e se non é correcto mandarase unha mensaxe de resposta HTTP con código de estado 400 e corpo baleiro. @@ -307,12 +307,12 @@ Tamén se implementará a través de CXF unha validación do XML entrante no cor Fluxos de integración ===================== -Os fluxos de integración detallan a secuencia que ten que facer unha aplicación cliente para integrarse coa aplicación NavalPlan e en que secuencia poderá realizar as chamadas aos servizos web dispoñibles. +Os fluxos de integración detallan a secuencia que ten que facer unha aplicación cliente para integrarse coa aplicación LibrePlan e en que secuencia poderá realizar as chamadas aos servizos web dispoñibles. Os servizos web atópanse dispoñibles a partir da URL_BASE da aplicación en /ws/rest/: - * URL Base de Servizos: URL_BASE_NAVALPLANNER_WEBAPP/ws/rest - * Exemplo: http://www.navalplan.org/navalplanner-webapp/ws/rest + * URL Base de Servizos: URL_BASE_LIBREPLAN_WEBAPP/ws/rest + * Exemplo: http://www.libreplan.org/libreplan-webapp/ws/rest A partir deste intre denominase a esta URL de servizos coma *BASE_SERVICES_URL*. @@ -327,7 +327,7 @@ Descrición * A incorporación de materiais permitirá asociar materiais a necesidades para o inicio de tarefas no planificador. Roles - * Cliente: proporciona nova información sobre os materiais ao servidor NavalPlan. + * Cliente: proporciona nova información sobre os materiais ao servidor LibrePlan. * Servidor: procesa a petición do cliente incorporando a nova información dos materiais. Precondicións @@ -341,10 +341,10 @@ Postcondicións * os seus campos propios serán actualizados coa nova información. * se un material cambia de categoría modificarase a categoría a que pertence o material. -Clases involucradas en NavalPlan +Clases involucradas en LibrePlan .. image:: images/materials.png :width: 300 - :alt: Diagrama de Clases do dominio de Materiais en NavalPlan + :alt: Diagrama de Clases do dominio de Materiais en LibrePlan Descrición do fluxo 1. A aplicación cliente que se integra xerará un ficheiro seguindo o formato detallado. @@ -356,7 +356,7 @@ Descrición do fluxo Exemplo de ficheiro de importación :: - + @@ -364,7 +364,7 @@ Exemplo de ficheiro de importación - + @@ -398,7 +398,7 @@ Descrición * Exemplos de etiquetas: Zonas do Buque, Prioridades, Centros de Coste, etc... Roles - * Cliente: proporciona nova información sobre as etiquetas ao servidor NavalPlan. + * Cliente: proporciona nova información sobre as etiquetas ao servidor LibrePlan. * Servidor: procesa a petición do cliente incorporando a nova información das etiquetas. Precondicións @@ -413,10 +413,10 @@ Postcondicións * os seus campos propios serán actualizados coa nova información. -Clases involucradas en NavalPlan +Clases involucradas en LibrePlan .. image:: images/labels.png :width: 200 - :alt: Diagrama de Clases do dominio de Etiquetas en NavalPlan + :alt: Diagrama de Clases do dominio de Etiquetas en LibrePlan Descrición do fluxo 1. A aplicación cliente que se integra xerará un ficheiro seguindo o formato detallado. @@ -428,7 +428,7 @@ Descrición do fluxo Exemplo de ficheiro de importación :: - +