Implemented: renamed the directory specialpurpose to plugins

(OFBIZ-7972)

In another step towards completing the plugin system for OFBiz, we renamed
the /specialpurpose directory to /plugins and changed all occurences of the
word "specialpurpose" to "plugins" in all files found in the system

Reference discussion: http://markmail.org/message/hpyuxkmftiyn44w2


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/trunk@1778271 13f79535-47bb-0310-9956-ffa450edef68

.gitignore

@@ -3,7 +3,7 @@ build/
 applications/*/build
 framework/*/build
 hot-deploy/*/build
-specialpurpose/*/build
+plugins/*/build
 runtime/git-rebase/*
 runtime/SvnInfo.ftl
 runtime/GitInfo.ftl

.hgignore

@@ -1,5 +1,5 @@
 syntax: regexp
-^(framework|applications|specialpurpose)/[^/]+/build/.*$
+^(framework|applications|plugins)/[^/]+/build/.*$
 ^ofbiz\.jar$
 ^runtime/data/derby/.*$
 ^runtime/logs/.*(log|html)(|.\d+)$

LICENSE

@@ -225,8 +225,8 @@ under the "MIT" license. For details, see framework/images/webapp/images/date/da
 This product bundles "jQuery" and "jQuery" plugins and extensions, which are available
 under the "MIT" license. For details, see:
 framework/images/webapp/images/jquery/
-specialpurpose/webpos/webapp/webpos/images/js/jquery.hotkeys-0.7.9.min.js
-specialpurpose/webpos/webapp/webpos/images/js/WebPosHotkeys.js
+plugins/webpos/webapp/webpos/images/js/jquery.hotkeys-0.7.9.min.js
+plugins/webpos/webapp/webpos/images/js/WebPosHotkeys.js
 
 =========================================================================
 
@@ -239,15 +239,15 @@ For details, see framework/images/webapp/images/icons/
 
 This product bundles files from the "Birt" technology platform (www.eclipse.org/birt/)
 which are available under the "Eclipse Public License - v 1.0".
-For details, see specialpurpose/birt/webapp/birt/webcontent/birt/
+For details, see plugins/birt/webapp/birt/webcontent/birt/
 
 =========================================================================
 
 This product bundles "Webhelp for DocBook", which is available
-under the "MIT" License. For details, see specialpurpose/cmssite/template/docbook/webhelp/
+under the "MIT" License. For details, see plugins/cmssite/template/docbook/webhelp/
 
 =========================================================================
 
 This product bundles "DocBook XSL Stylesheets 1.77.1", which is available
 under the "MIT" license.
-For details, see specialpurpose/cmssite/template/docbook/
+For details, see plugins/cmssite/template/docbook/

README.md

@@ -480,7 +480,7 @@ OFBiz plugin system
 -------------------
 
 OFBiz provides an extension mechanism through plugins. Plugins are standard
-OFBiz components that reside in the specialpurpose directory. Plugins can be
+OFBiz components that reside in the plugins directory. Plugins can be
 added manually or fetched from a maven repository. The standard tasks for
 managing plugins are listed below.
 
@@ -508,14 +508,14 @@ If you have a plugin called mycustomplugin and want to install it in OFBiz follo
 below instructions:
 
 - Extract the plugin if it is compressed
-- Place the extracted directory into /specialpurpose
+- Place the extracted directory into /plugins
 - Run the below command
 
 `gradlew installPlugin -PpluginId=myplugin`
 
 The above commands achieve the following:
 
-- add the plugin to /specialpurpose/component-load.xml
+- add the plugin to /plugins/component-load.xml
 - executes the task "install" in the plugin's build.gradle file if it exists
 
 ### Uninstall a plugin
@@ -528,7 +528,7 @@ run the below command
 The above commands achieve the following:
 
 - executes the task "uninstall" in the plugin's build.gradle file if it exists
-- removes the plugin from /specialpurpose/component-load.xml
+- removes the plugin from /plugins/component-load.xml
 
 ### Remove a plugin
 
@@ -551,8 +551,8 @@ Create a new plugin. The following project parameters are passed:
 
 The above commands achieve the following:
 
-- create a new plugin in /specialpurpose/myplugin
-- add the plugin to /specialpurpose/component-load.xml
+- create a new plugin in /plugins/myplugin
+- add the plugin to /plugins/component-load.xml
 
 ### Push a plugin to a repository
 

applications/accounting/data/DemoPaymentsInvoices.xml

@@ -76,7 +76,7 @@ under the License.
     <InvoiceItem invoiceId="8001" invoiceItemSeqId="1" invoiceItemTypeId="PINV_SURCHARGE_ADJ" taxableFlag="Y" quantity="1.000000" amount="10.000"/>
 
     <!--
-         specialpurpose components are loaded after applications components. DemoSupplier & AcctBigSupplier data exists in ecommerce component. 
+         plugins components are loaded after applications components. DemoSupplier & AcctBigSupplier data exists in ecommerce component. 
          So it creates foreign key violation as accounting component is loaded first and it tries to find 'DemoSupplier' and 'AcctBigSupplier' party.
          This change will help to load test data without producing any foreign key error. 
      -->

applications/commonext/data/EntityDiagramGroupData.xml

@@ -261,6 +261,6 @@ under the License.
     <EntityGroupEntry entityGroupId="6930" entityOrPackage="org.apache.ofbiz.security" applEnumId="ESIA_INCLUDE"/>
 -    <EntityGroup entityGroupId="6990" entityGroupName="Technical: WebPOS, OAGIS, Other"/>
 -    <EntityGroupEntry entityGroupId="6990" entityOrPackage="org.apache.ofbiz.pos.terminal" applEnumId="ESIA_INCLUDE"/>
-    <EntityGroupEntry entityGroupId="6990" entityOrPackage="org.apache.ofbiz.specialpurpose.oagis" applEnumId="ESIA_INCLUDE"/>
+    <EntityGroupEntry entityGroupId="6990" entityOrPackage="org.apache.ofbiz.plugins.oagis" applEnumId="ESIA_INCLUDE"/>
     <EntityGroupEntry entityGroupId="6990" entityOrPackage="org.apache.ofbiz.catalina.session" applEnumId="ESIA_INCLUDE"/>
 </entity-engine-xml>

applications/content/data/DemoBlogEntryData.xml

@@ -19,7 +19,7 @@
 -->
 <entity-engine-xml>
     <DataResource dataResourceId="BLG10000" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" isPublic="Y" createdByUserLogin="admin" createdDate="2004-01-16 01:24:06.522" lastModifiedByUserLogin="admin" lastModifiedDate="2010-09-26 13:13:32.482" mimeTypeId="application/octet-stream" statusId="CTNT_PUBLISHED"/>
-    <DataResource dataResourceId="BLG10001" dataResourceTypeId="OFBIZ_FILE_BIN" dataTemplateTypeId="NONE" statusId="CTNT_PUBLISHED" mimeTypeId="image/jpeg" objectInfo="specialpurpose/ecommerce/data/cutekid.jpg" isPublic="Y" createdDate="2007-01-23 16:46:22.843" createdByUserLogin="bigal" lastModifiedDate="2007-01-23 16:46:22.843" lastModifiedByUserLogin="bigal"/>
+    <DataResource dataResourceId="BLG10001" dataResourceTypeId="OFBIZ_FILE_BIN" dataTemplateTypeId="NONE" statusId="CTNT_PUBLISHED" mimeTypeId="image/jpeg" objectInfo="plugins/ecommerce/data/cutekid.jpg" isPublic="Y" createdDate="2007-01-23 16:46:22.843" createdByUserLogin="bigal" lastModifiedDate="2007-01-23 16:46:22.843" lastModifiedByUserLogin="bigal"/>
     <DataResource dataResourceId="BLG10002" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" statusId="CTNT_PUBLISHED" createdDate="2007-01-23 16:46:22.984" createdByUserLogin="bigal" lastModifiedDate="2007-01-23 16:46:38.671" lastModifiedByUserLogin="bigal"/>
     <DataResource dataResourceId="BLG10003" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" statusId="CTNT_PUBLISHED" createdDate="2007-01-23 16:47:49.343" createdByUserLogin="bigal" lastModifiedDate="2007-01-23 16:47:49.343" lastModifiedByUserLogin="bigal"/>
     <DataResource dataResourceId="BLG10004" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" statusId="CTNT_PUBLISHED" createdDate="2007-01-23 16:50:38.171" createdByUserLogin="blog_guest" lastModifiedDate="2007-01-23 16:50:38.171" lastModifiedByUserLogin="blog_guest"/>

applications/datamodel/README.md

@@ -1,7 +1,7 @@
 <img src="http://ofbiz.apache.org/images/logo.png" alt="Apache OFBiz" />
 
 # Datamodel component
-This OFBiz component contains all entity definitions used in the various components in the base and specialpurpose stack.
+This OFBiz component contains all entity definitions used in the various components in the base and plugins stack.
 
 ## more information
 For more information about this component visit the product page in the OFBiz WIKI, 

build.gradle

@@ -30,7 +30,7 @@ apply from: 'common.gradle'
 
 // global properties
 ext.os = System.getProperty('os.name').toLowerCase()
-ext.pluginsDir = "${rootDir}/specialpurpose"
+ext.pluginsDir = "${rootDir}/plugins"
 
 // java settings
 def jvmArguments = ['-Xms128M', '-Xmx1024M']
@@ -258,7 +258,7 @@ eclipse.classpath.file.whenMerged { classpath ->
             entry.path ==~ '.*/+(' + componentName.tokenize(osDirSeparator).last() + ')$' ||
             entry.path ==~ /(\/+framework)$/ ||
             entry.path ==~ /(\/+applications)$/ ||
-            entry.path ==~ /(\/+specialpurpose)$/ ||
+            entry.path ==~ /(\/+plugins)$/ ||
             entry.path ==~ /(\/+themes)$/ ||
             entry.path ==~ /(\/+hot-deploy)$/ ||
             entry.path ==~ eclipseEntry + '/config' ||
@@ -590,9 +590,9 @@ task installPlugin(group: ofbizPlugin, description: 'activate a plugin and run i
     }
 
     if (project.hasProperty('pluginId')) {
-        if (subprojectExists(":specialpurpose:${pluginId}")) {
-            if (taskExistsInproject(":specialpurpose:${pluginId}", 'install')) {
-                dependsOn ":specialpurpose:${pluginId}:install"
+        if (subprojectExists(":plugins:${pluginId}")) {
+            if (taskExistsInproject(":plugins:${pluginId}", 'install')) {
+                dependsOn ":plugins:${pluginId}:install"
                 doLast { println "installed plugin ${pluginId}" }
             } else {
                 doLast { println "No install task defined for plugin ${pluginId}" }
@@ -615,13 +615,13 @@ task uninstallPlugin(group: ofbizPlugin, description: 'run the uninstall task if
         if (!project.hasProperty('pluginId')) {
             throw new GradleException('Missing property \"pluginId\"')
         }
-        if (!subprojectExists(":specialpurpose:${pluginId}")) {
+        if (!subprojectExists(":plugins:${pluginId}")) {
             throw new GradleException("Plugin \"${pluginId}\" does not exist")
         }
     }
 
-    if (project.hasProperty('pluginId') && taskExistsInproject(":specialpurpose:${pluginId}", 'uninstall')) {
-        dependsOn ":specialpurpose:${pluginId}:uninstall"
+    if (project.hasProperty('pluginId') && taskExistsInproject(":plugins:${pluginId}", 'uninstall')) {
+        dependsOn ":plugins:${pluginId}:uninstall"
     }
 
     doLast {
@@ -630,7 +630,7 @@ task uninstallPlugin(group: ofbizPlugin, description: 'run the uninstall task if
 }
 
 task removePlugin(group: ofbizPlugin, description: 'Uninstall a plugin and delete its files') {
-    if (project.hasProperty('pluginId') && subprojectExists(":specialpurpose:${pluginId}")) {
+    if (project.hasProperty('pluginId') && subprojectExists(":plugins:${pluginId}")) {
         dependsOn uninstallPlugin
     }
 
@@ -647,7 +647,7 @@ task pushPlugin(group: ofbizPlugin, description: 'push an existing plugin to loc
 
     if (project.hasProperty('pluginId')) {
         doFirst {
-            if (!subprojectExists(":specialpurpose:${pluginId}")) {
+            if (!subprojectExists(":plugins:${pluginId}")) {
                 throw new GradleException("Plugin ${pluginId} does not exist, cannot publish")
             }
         }
@@ -675,7 +675,7 @@ task pushPlugin(group: ofbizPlugin, description: 'push an existing plugin to loc
             }
         }
 
-        if (subprojectExists(":specialpurpose:${pluginId}")) {
+        if (subprojectExists(":plugins:${pluginId}")) {
             dependsOn publishToMavenLocal
         }
 
@@ -778,7 +778,7 @@ task cleanAnt(group: cleanupGroup, type: Delete, description: "clean old artifac
     /* TODO this task is temporary and should be deleted after some
      * time when users have updated their trees. */
     doLast {
-        ['framework', 'specialpurpose', 'applications'].each { componentGroup ->
+        ['framework', 'plugins', 'applications'].each { componentGroup ->
             file(componentGroup).eachDir { component ->
                 delete file(component.toString() + '/build')
             }

common.gradle

@@ -19,7 +19,7 @@
 def iterateOverActiveComponents(applyFunction) {
     def frameworkComponents = new XmlParser().parse("${rootDir}/framework/component-load.xml")
     def applicationsComponents = new XmlParser().parse("${rootDir}/applications/component-load.xml")
-    def specialpurposeComponents = new XmlParser().parse("${rootDir}/specialpurpose/component-load.xml")
+    def pluginsComponents = new XmlParser().parse("${rootDir}/plugins/component-load.xml")
 
     applyFunction file("${rootDir}/framework/start")
 
@@ -29,8 +29,8 @@ def iterateOverActiveComponents(applyFunction) {
     applicationsComponents.children().each { component ->
         applyFunction file("${rootDir}/applications/"+component.@"component-location")
     }
-    specialpurposeComponents.children().each { component ->
-        applyFunction file("${rootDir}/specialpurpose/"+component.@"component-location")
+    pluginsComponents.children().each { component ->
+        applyFunction file("${rootDir}/plugins/"+component.@"component-location")
     }
 
     file("${rootDir}/themes").eachDir { component ->

framework/base/config/component-load.xml

@@ -23,6 +23,6 @@ under the License.
     <load-components parent-directory="framework"/>
     <load-components parent-directory="themes"/>
     <load-components parent-directory="applications"/>
-    <load-components parent-directory="specialpurpose"/>
+    <load-components parent-directory="plugins"/>
     <load-components parent-directory="hot-deploy"/>
 </component-loader>

framework/base/dtd/ofbiz-component.xsd

@@ -196,7 +196,7 @@ under the License.
             <xs:annotation>
                 <xs:documentation>
                     This value determines in which application menu the application is shown. 
-                    For instance "secondary" is used by specialpurpose and webtools webapps to put their menu-names in the second menu.
+                    For instance "secondary" is used by plugins and webtools webapps to put their menu-names in the second menu.
                     Note that not all OOTB themes use this "secondary" option, for instance Flat-Grey does not.
                 </xs:documentation>
             </xs:annotation>

framework/base/src/main/java/org/apache/ofbiz/base/util/UtilProperties.java

@@ -519,7 +519,7 @@ public static void setPropertyValue(String resource, String name, String value)
                      +"# Dynamically modified by OFBiz Framework (org.apache.ofbiz.base.util : UtilProperties.setPropertyValue)\n"
                      +"#                                                                              \n"
                      +"# By default the screen is 1024x768 wide. If you want to use another screen size,\n"
-                     +"# you must create a new directory under specialpurpose/pos/screens, like the 800x600.\n"
+                     +"# you must create a new directory under plugins/pos/screens, like the 800x600.\n"
                      +"# You must also set the 3 related parameters (StartClass, ClientWidth, ClientHeight) accordingly.\n"
                      +"#");
              } else {

framework/documents/SingleSignOn.xml

@@ -123,12 +123,12 @@
     <section>
         <title>LDAP Component</title>
         <para>
-            OFBiz uses the LDAP component in the specialpurpose to check the security in a web application. OFBiz disabled LDAP component as default, you can enable this component by take the comment out from specialpurpose/component-load.xml file.
+            OFBiz uses the LDAP component in the plugins to check the security in a web application. OFBiz disabled LDAP component as default, you can enable this component by take the comment out from plugins/component-load.xml file.
         </para>
         <section>
             <title>LDAP Properties</title>
             <para>
-                LDAP properties file is specialpurpose/ldap/config/ldap.xml. You can change a filter condition you want.
+                LDAP properties file is plugins/ldap/config/ldap.xml. You can change a filter condition you want.
             </para>
             <section>
                 <title>Attributes</title>

hot-deploy/README.txt

@@ -4,7 +4,7 @@ All components in this tree will be loaded after the OFBiz components, including
 framework
 themes
 applications
-specialpurpose
+plugins
 
 The hot-deploy Auto-Loading feature loads all components in the order they are found (i.e. alphabetic or creation date).
 

specialpurpose/assetmaint/README.md → plugins/assetmaint/README.md

@@ -17,4 +17,4 @@ JIRA issues related to this component can be found at
 
 ## commits
 Committed revisions can be viewed at 
-http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/assetmaint/
+http://svn.apache.org/viewvc/ofbiz/trunk/plugins/assetmaint/

specialpurpose/assetmaint/entitydef/entitymodel.xml → plugins/assetmaint/entitydef/entitymodel.xml

@@ -28,7 +28,7 @@
     <description>None</description>
     <version>1.0</version>
 
-    <view-entity entity-name="FixedAssetAndIdent" package-name="org.apache.ofbiz.specialpurpose.assetmaint"
+    <view-entity entity-name="FixedAssetAndIdent" package-name="org.apache.ofbiz.plugins.assetmaint"
         title="FixedAsset and FixedAssetIdent View Entity">
         <member-entity entity-alias="FA" entity-name="FixedAsset"/>
         <member-entity entity-alias="FAI" entity-name="FixedAssetIdent"/>
@@ -39,7 +39,7 @@
         </view-link>
     </view-entity>
     <view-entity entity-name="FixedAssetMaintWorkEffortAndPartyAssignment"
-        package-name="org.apache.ofbiz.specialpurpose.assetmaint"
+        package-name="org.apache.ofbiz.plugins.assetmaint"
         title="View of FixedAssetMaint and WorkEffort and WorkEffortPartyAssignment">
         <member-entity entity-alias="FAM" entity-name="FixedAssetMaint"/>
         <member-entity entity-alias="WE" entity-name="WorkEffort"/>
@@ -67,7 +67,7 @@
         </relation>
     </view-entity>
     <view-entity entity-name="FixedAssetMaintWorkEffortAndTimeEntry"
-        package-name="org.apache.ofbiz.specialpurpose.assetmaint"
+        package-name="org.apache.ofbiz.plugins.assetmaint"
         title="View of FixedAssetMaint and WorkEffort and TimeEntry">
         <member-entity entity-alias="FAM" entity-name="FixedAssetMaint"/>
         <member-entity entity-alias="WE" entity-name="WorkEffort"/>
@@ -91,7 +91,7 @@
         </relation>
     </view-entity>
     <view-entity entity-name="ItemIssuanceInventoryItemAndProduct"
-        package-name="org.apache.ofbiz.specialpurpose.assetmaint"
+        package-name="org.apache.ofbiz.plugins.assetmaint"
         title="View of Item Issuance,Inventory Item and Product">
         <member-entity entity-alias="IMIE" entity-name="ItemIssuance"/>
         <member-entity entity-alias="IYIM" entity-name="InventoryItem"/>
@@ -131,7 +131,7 @@
         </relation>
     </view-entity>
     <view-entity entity-name="ProductInventoryItemAndItemIssuance"
-        package-name="org.apache.ofbiz.specialpurpose.assetmaint"
+        package-name="org.apache.ofbiz.plugins.assetmaint"
         title="View of Product,Inventory Item and ItemIssuance">
         <member-entity entity-alias="PT" entity-name="Product"/>
         <member-entity entity-alias="IYIM" entity-name="InventoryItem"/>

specialpurpose/birt/README.md → plugins/birt/README.md

@@ -2,4 +2,4 @@
 # Birt component
 ## more informationFor more information about this component visit the page in the OFBiz WIKI, which can be found at https://cwiki.apache.org/confluence/display/OFBIZ/Using+BIRT+with+OFBizMore information about the birt product can be found at: http://www.eclipse.org/birt/
 ## IssuesJIRA issues related to this component can be found at https://issues.apache.org/jira/browse/OFBIZ/component/12321022
-## commitsCommitted revisions can be viewed at http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/bith/
+## commitsCommitted revisions can be viewed at http://svn.apache.org/viewvc/ofbiz/trunk/plugins/bith/

specialpurpose/birt/data/BirtHelpData.xml → plugins/birt/data/BirtHelpData.xml

@@ -20,7 +20,7 @@
 
 <entity-engine-xml>
     <DataResource dataResourceId="HELP_BIRT" localeString="en" dataResourceTypeId="OFBIZ_FILE"
-                  objectInfo="specialpurpose/birt/data/helpdata/HELP_BIRT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
+                  objectInfo="plugins/birt/data/helpdata/HELP_BIRT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
                   dataResourceName="BIRT" mimeTypeId="text/xml" isPublic="Y" />
     <Content contentId="HELP_BIRT" contentTypeId="DOCUMENT" contentName="BIRT Overview" templateDataResourceId="HELP_TEMPL"
              dataResourceId="HELP_BIRT" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>

specialpurpose/birt/documents/Birt.xml → plugins/birt/documents/Birt.xml

@@ -24,6 +24,6 @@
     <title>BIRT report generator.</title>
     <para> An example report sales can be found in the example component. </para>
     <para>
-        <xi:include href="../../../specialpurpose/birt/data/helpdata/HELP_BIRT.xml"/>
+        <xi:include href="../../../plugins/birt/data/helpdata/HELP_BIRT.xml"/>
     </para>
 </chapter>