diff --git a/entity/Comm_entity/Comm_entity.aod b/entity/Comm_entity/Comm_entity.aod index b190aad73d559d2a57d0e19cb254b49a53154760..7441cfe350ac876895a30a000ae9d33185f74c4c 100644 --- a/entity/Comm_entity/Comm_entity.aod +++ b/entity/Comm_entity/Comm_entity.aod @@ -15,7 +15,7 @@ <columnName>ADDR</columnName> <caption>${COMM_ADDRESS}</caption> <contentTypeProcess>%aditoprj%/entity/Comm_entity/entityfields/addr/contentTypeProcess.js</contentTypeProcess> - <valueProcess>%aditoprj%/entity/Comm_entity/entityfields/addr/valueProcess.js</valueProcess> + <onValidation>%aditoprj%/entity/Comm_entity/entityfields/addr/onValidation.js</onValidation> </entityField> <entityField> <name>COMMID</name> @@ -41,6 +41,7 @@ <columnName>MEDIUM_ID</columnName> <caption>Medium</caption> <possibleItemsProcess>%aditoprj%/entity/Comm_entity/entityfields/medium_id/possibleItemsProcess.js</possibleItemsProcess> + <valueProcess>%aditoprj%/entity/Comm_entity/entityfields/medium_id/valueProcess.js</valueProcess> </entityField> <entityField> <name>RELATION_ID</name> @@ -87,6 +88,12 @@ So, for only showing telephone-types you&apos;ve to specify this parameter w <entityIncomingField> <name>#INCOMING</name> </entityIncomingField> + <entityParameter> + <name>RelationsMainCountry_param</name> + <code>%aditoprj%/entity/Comm_entity/entityfields/relationsmaincountry_param/code.js</code> + <mandatory v="false" /> + <description>PARAMETER</description> + </entityParameter> </entityFields> <linkInformation> <linkInformation> diff --git a/entity/Comm_entity/conditionProcess.js b/entity/Comm_entity/conditionProcess.js index 7ab504b7b04216aec94e4d2dbbcba228e8c50819..52f44d3905881512659a8e605db36eb05e32a336 100644 --- a/entity/Comm_entity/conditionProcess.js +++ b/entity/Comm_entity/conditionProcess.js @@ -1,42 +1,38 @@ -import("system.logging"); -import("system.text"); -import("system.result"); -import("system.vars"); -import("Sql_lib"); -import("Keyword_lib"); - -var cond, relId, mediumCategories, keywordUtil; - - - -cond = ""; -if(vars.exists("$param.RelId_param")){ - - relId = vars.get("$param.RelId_param"); - - if (relId != null && relId != "" && relId != undefined) - { - cond += " and COMM.RELATION_ID in ('" + relId + "')";//TODO: quoting/prevent sql-injection - } -} -if (vars.exists("$param.MediumCategoriesFilter_param")){ - - mediumCategories = vars.get("$param.MediumCategoriesFilter_param"); - if (mediumCategories != null && mediumCategories != "" && mediumCategories != undefined) - { - - mediumCategories = text.decodeMS(mediumCategories); - keywordUtil = new KeywordUtils(); - var kwd = keywordUtil.createKeyword("COMM.MEDIUM"); - kwd.filter(function(id, name, customs){ - return mediumCategories.indexOf(customs.category) > -1; - }); - mediumIds = kwd.toArray("id"); - if (mediumIds.length == 0) - throw new Error();//TODO: add message - - cond += " and COMM.MEDIUM_ID in (" + mediumIds.join(", ") + ")"; - } -} - -result.string(cond ? "1 = 1 " + cond: "1 = 2"); \ No newline at end of file +import("system.db"); +import("system.logging"); +import("system.text"); +import("system.result"); +import("system.vars"); +import("Sql_lib"); +import("Keyword_lib"); + +var cond, relId, mediumCategories, keywordUtil, condStr; + +cond = new SqlCondition(); +if(vars.exists("$param.RelId_param")){ + relId = vars.get("$param.RelId_param"); + + if (relId != null && relId != ""){ + cond.andPrepare("COMM.RELATION_ID", "# = ?", relId); + } +} + +if (vars.exists("$param.MediumCategoriesFilter_param")){ + mediumCategories = vars.get("$param.MediumCategoriesFilter_param"); + if (mediumCategories != null && mediumCategories != "") { + mediumCategories = text.decodeMS(mediumCategories); + keywordUtil = new KeywordUtils(); + var kwd = keywordUtil.createKeyword("COMM.MEDIUM"); + kwd.filter(function(id, name, customs){ + return mediumCategories.indexOf(customs.category) > -1; + }); + mediumIds = kwd.toArray("id"); + if (mediumIds.length == 0) + throw new Error();//TODO: add message + + cond.and("COMM.MEDIUM_ID in (" + mediumIds.join(", ") + ")"); + } +} + +condStr = db.translateCondition([cond.toString("1 = 2"), cond.preparedValues]);//TODO: this should not be necessary in the future +result.string(condStr); \ No newline at end of file diff --git a/entity/Comm_entity/entityfields/addr/contentTypeProcess.js b/entity/Comm_entity/entityfields/addr/contentTypeProcess.js index 06a2fe06be4ffc09f15cfc7d2fcc671bdf6456dc..d447305cf063f92a6dc121a43b9a4df1f5f706b7 100644 --- a/entity/Comm_entity/entityfields/addr/contentTypeProcess.js +++ b/entity/Comm_entity/entityfields/addr/contentTypeProcess.js @@ -3,26 +3,12 @@ import("system.vars"); import("system.result"); import("system.neon"); -var keywordUtils, category, medium, contentType; +var keywordUtils, medium, contentType; //TODO: add constants for contentTypes #1022547 medium = vars.get("$field.MEDIUM_ID"); if (medium){ keywordUtils = new KeywordUtils(); - category = keywordUtils.createKeyword("COMM.MEDIUM").getPropForKey(medium, "category", true); - switch (category) { - case "PHONE": - contentType = "TELEPHONE"; - break; - case "EMAIL": - contentType = "EMAIL"; - break; - case "WEBSITE": - contentType = "LINK"; - break; - default: - contentType = "TEXT"; - break; - } + contentType = keywordUtils.createKeyword("COMM.MEDIUM").getPropForKey(medium, "contentType", true) || "TEXT"; } else { contentType = "TEXT"; diff --git a/entity/Comm_entity/entityfields/addr/onValidation.js b/entity/Comm_entity/entityfields/addr/onValidation.js new file mode 100644 index 0000000000000000000000000000000000000000..b99bc84225439980d4ed10a88a6a45f9f30c082a --- /dev/null +++ b/entity/Comm_entity/entityfields/addr/onValidation.js @@ -0,0 +1,23 @@ +import("system.logging"); +import("system.translate"); +import("system.vars"); +import("system.net"); +import("system.result"); +import("system.mail"); +import("Keyword_lib"); +import("Comm_lib"); + +var kwdUtil = new KeywordUtils(); +var kwd = kwdUtil.createKeyword("COMM.MEDIUM"); +var commMedium = vars.get("$field.MEDIUM_ID"); +var commCategory = kwd.getPropForKey(commMedium, "contentType", true);//TODO: maybe accessible via $property - then it's not needed to keep this information within the keyword + +var fn = CommValidationUtil.makeValidationFn(commCategory); +if (fn != null){ + var commAddr = vars.get("$local.value");//contains the entered value - the field contains the value only after successfull validation + var additional = CommValidationUtil.getExtensionsBlueprint(); + additional.countryCode = vars.get("$param.RelationsMainCountry_param");//TODO: try to use users language first and then the companies + var res = fn.call(null, commAddr, additional); + if (res != null) + result.string(res); +} \ No newline at end of file diff --git a/entity/Comm_entity/entityfields/medium_id/possibleItemsProcess.js b/entity/Comm_entity/entityfields/medium_id/possibleItemsProcess.js index f73dccbca8682450c0237f4b5af827e2d2ae6182..a5f76ab6c894de82dbf14e1c0dcbfd4c21f2b82e 100644 --- a/entity/Comm_entity/entityfields/medium_id/possibleItemsProcess.js +++ b/entity/Comm_entity/entityfields/medium_id/possibleItemsProcess.js @@ -1,3 +1,4 @@ +import("system.logging"); import("system.text"); import("system.vars"); import("system.result"); @@ -6,7 +7,7 @@ import("Keyword_lib"); var mediumCategories, kwdUtils, kwd, items; kwdUtils = new KeywordUtils(); -if (vars.exists("$param.MediumCategoriesFilter_param") && (mediumCategories = vars.get("$param.MediumCategoriesFilter_param")) != null){ +if (vars.exists("$param.MediumCategoriesFilter_param") && (mediumCategories = vars.get("$param.MediumCategoriesFilter_param")) != ""){ mediumCategories = text.decodeMS(mediumCategories); kwd = kwdUtils.createKeyword("COMM.MEDIUM"); kwd.filter(function(id, name, customs){ diff --git a/entity/Comm_entity/entityfields/relationsmaincountry_param/code.js b/entity/Comm_entity/entityfields/relationsmaincountry_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..c14118ef254f82f6bbb35c3d32ca5974b113a1d0 --- /dev/null +++ b/entity/Comm_entity/entityfields/relationsmaincountry_param/code.js @@ -0,0 +1,22 @@ +import("system.result"); +import("system.db"); +import("system.logging"); +import("system.vars"); +import("Sql_lib"); + +var relId, country; + +if (vars.exists("$param.RelId_param")) { + relId = vars.get("$param.RelId_param"); + if (relId != "" && relId != null){ + var cond = new SqlCondition(); + cond.andPrepare("RELATION.RELATIONID", "# = ?", relId); + //TODO: this should happen by 1:1 links instead of manually requesting the data by a select + country = db.cell(["select ADDRESS.COUNTRY from ADDRESS " + + "join RELATION on RELATION.ADDRESS_ID = ADDRESS.ADDRESSID " + + cond.toWhereString(), cond.preparedValues]); + + if (country != "") + result.string(country); + } +} \ No newline at end of file diff --git a/entity/Org_entity/Org_entity.aod b/entity/Org_entity/Org_entity.aod index 2c87ea2f120fbb95471b357236b7e7e129a9813e..857f8573e8b1395215ce18af443c5a5049fcc7da 100644 --- a/entity/Org_entity/Org_entity.aod +++ b/entity/Org_entity/Org_entity.aod @@ -260,6 +260,66 @@ </entityParameter> </children> </entityOutgoingField> + <entityOutgoingField> + <name>OrgCommEmail_dfo</name> + <fieldType>DEPENDENCY_OUT</fieldType> + <caption>Communication E-Mail</caption> + <dependency> + <name>dependency</name> + <entityName>Comm_entity</entityName> + <fieldName>#INCOMING</fieldName> + </dependency> + <children> + <entityParameter> + <name>RelId_param</name> + <code>%aditoprj%/entity/Org_entity/entityfields/orgcommemail_dfo/children/relid_param/code.js</code> + </entityParameter> + <entityParameter> + <name>MediumCategoriesFilter_param</name> + <code>%aditoprj%/entity/Org_entity/entityfields/orgcommemail_dfo/children/mediumcategoriesfilter_param/code.js</code> + </entityParameter> + </children> + </entityOutgoingField> + <entityOutgoingField> + <name>OrgCommPhone_dfo</name> + <fieldType>DEPENDENCY_OUT</fieldType> + <caption>Communication Phone</caption> + <dependency> + <name>dependency</name> + <entityName>Comm_entity</entityName> + <fieldName>#INCOMING</fieldName> + </dependency> + <children> + <entityParameter> + <name>RelId_param</name> + <code>%aditoprj%/entity/Org_entity/entityfields/orgcommphone_dfo/children/relid_param/code.js</code> + </entityParameter> + <entityParameter> + <name>MediumCategoriesFilter_param</name> + <code>%aditoprj%/entity/Org_entity/entityfields/orgcommphone_dfo/children/mediumcategoriesfilter_param/code.js</code> + </entityParameter> + </children> + </entityOutgoingField> + <entityOutgoingField> + <name>OrgCommOthers_dfo</name> + <fieldType>DEPENDENCY_OUT</fieldType> + <caption>Communication Other</caption> + <dependency> + <name>dependency</name> + <entityName>Comm_entity</entityName> + <fieldName>#INCOMING</fieldName> + </dependency> + <children> + <entityParameter> + <name>RelId_param</name> + <code>%aditoprj%/entity/Org_entity/entityfields/orgcommothers_dfo/children/relid_param/code.js</code> + </entityParameter> + <entityParameter> + <name>MediumCategoriesFilter_param</name> + <code>%aditoprj%/entity/Org_entity/entityfields/orgcommothers_dfo/children/mediumcategoriesfilter_param/code.js</code> + </entityParameter> + </children> + </entityOutgoingField> <entityOutgoingField> <name>OrgContract_dfo</name> <fieldType>DEPENDENCY_OUT</fieldType> diff --git a/entity/Org_entity/entityfields/orgcommemail_dfo/children/mediumcategoriesfilter_param/code.js b/entity/Org_entity/entityfields/orgcommemail_dfo/children/mediumcategoriesfilter_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..aaff61e4c8898ae395726ecc423de32a449ffedb --- /dev/null +++ b/entity/Org_entity/entityfields/orgcommemail_dfo/children/mediumcategoriesfilter_param/code.js @@ -0,0 +1,4 @@ +import("system.text"); +import("system.result"); + +result.string(text.encodeMS(["EMAIL"])); diff --git a/entity/Org_entity/entityfields/orgcommemail_dfo/children/relid_param/code.js b/entity/Org_entity/entityfields/orgcommemail_dfo/children/relid_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..c618e8d6e5ce719d68e284f7c5b4b050c95b25d3 --- /dev/null +++ b/entity/Org_entity/entityfields/orgcommemail_dfo/children/relid_param/code.js @@ -0,0 +1,4 @@ +import("system.result"); +import("system.vars"); + +result.string(vars.get("$field.RELATIONID")); \ No newline at end of file diff --git a/entity/Org_entity/entityfields/orgcommothers_dfo/children/mediumcategoriesfilter_param/code.js b/entity/Org_entity/entityfields/orgcommothers_dfo/children/mediumcategoriesfilter_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..4f54b7ffc8acbf3d404f6d45dea8b79e991ca573 --- /dev/null +++ b/entity/Org_entity/entityfields/orgcommothers_dfo/children/mediumcategoriesfilter_param/code.js @@ -0,0 +1,4 @@ +import("system.text"); +import("system.result"); + +result.string(text.encodeMS(["OTHER"])); diff --git a/entity/Org_entity/entityfields/orgcommothers_dfo/children/relid_param/code.js b/entity/Org_entity/entityfields/orgcommothers_dfo/children/relid_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..c618e8d6e5ce719d68e284f7c5b4b050c95b25d3 --- /dev/null +++ b/entity/Org_entity/entityfields/orgcommothers_dfo/children/relid_param/code.js @@ -0,0 +1,4 @@ +import("system.result"); +import("system.vars"); + +result.string(vars.get("$field.RELATIONID")); \ No newline at end of file diff --git a/entity/Org_entity/entityfields/orgcommphone_dfo/children/mediumcategoriesfilter_param/code.js b/entity/Org_entity/entityfields/orgcommphone_dfo/children/mediumcategoriesfilter_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..10d8f95a8428f41e01924b5a23ed0082fed74b2f --- /dev/null +++ b/entity/Org_entity/entityfields/orgcommphone_dfo/children/mediumcategoriesfilter_param/code.js @@ -0,0 +1,4 @@ +import("system.text"); +import("system.result"); + +result.string(text.encodeMS(["PHONE"])); diff --git a/entity/Org_entity/entityfields/orgcommphone_dfo/children/relid_param/code.js b/entity/Org_entity/entityfields/orgcommphone_dfo/children/relid_param/code.js new file mode 100644 index 0000000000000000000000000000000000000000..c618e8d6e5ce719d68e284f7c5b4b050c95b25d3 --- /dev/null +++ b/entity/Org_entity/entityfields/orgcommphone_dfo/children/relid_param/code.js @@ -0,0 +1,4 @@ +import("system.result"); +import("system.vars"); + +result.string(vars.get("$field.RELATIONID")); \ No newline at end of file diff --git a/neonView/OrgPreview_view/OrgPreview_view.aod b/neonView/OrgPreview_view/OrgPreview_view.aod index 2807fd672f1b75ef82268bceb91ba7827f7919db..dfa831fca34615d5f91a0f9de35496517147640b 100644 --- a/neonView/OrgPreview_view/OrgPreview_view.aod +++ b/neonView/OrgPreview_view/OrgPreview_view.aod @@ -1,52 +1,62 @@ -<?xml version="1.0" encoding="UTF-8"?> -<neonView xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.0" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonView/1.0.0"> - <name>OrgPreview_view</name> - <majorModelMode>DISTRIBUTED</majorModelMode> - <layout> - <boxLayout> - <name>layout</name> - </boxLayout> - </layout> - <children> - <cardViewTemplate> - <name>BasicCard_template</name> - <iconField>IMAGE</iconField> - <titleField>NAME</titleField> - <descriptionField>CUSTOMERCODE_DISPLAY_fieldGroup</descriptionField> - <entityField>#ENTITY</entityField> - </cardViewTemplate> - <neonViewReference> - <name>df605bb6-5d18-4233-abc0-1da82e4910ca</name> - <entityField>OrgAddress_dfo</entityField> - <view>AddressList_view</view> - </neonViewReference> - <neonViewReference> - <name>7fbd6034-4213-41f9-bb0d-c73d55b88d82</name> - <entityField>OrgComm_dfo</entityField> - <view>CommList_view</view> - </neonViewReference> - <genericViewTemplate> - <name>OrgInfo_template</name> - <showDrawer v="true" /> - <entityField>#ENTITY</entityField> - <fields> - <entityFieldLink> - <name>4bad7219-1a3a-4e6e-ae5a-533d3acb6845</name> - <entityField>LANGUAGE</entityField> - </entityFieldLink> - <entityFieldLink> - <name>5a397737-2768-4e16-8c58-890b8a26b4a2</name> - <entityField>STATUS</entityField> - </entityFieldLink> - <entityFieldLink> - <name>89e9aa74-1568-4f74-b42a-a02b13752802</name> - <entityField>TYPE</entityField> - </entityFieldLink> - <entityFieldLink> - <name>180e8467-4eb2-4f89-a59f-ff76b8810925</name> - <entityField>INFO</entityField> - </entityFieldLink> - </fields> - </genericViewTemplate> - </children> -</neonView> +<?xml version="1.0" encoding="UTF-8"?> +<neonView xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.0" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonView/1.0.0"> + <name>OrgPreview_view</name> + <majorModelMode>DISTRIBUTED</majorModelMode> + <layout> + <boxLayout> + <name>layout</name> + </boxLayout> + </layout> + <children> + <cardViewTemplate> + <name>BasicCard_template</name> + <iconField>IMAGE</iconField> + <titleField>NAME</titleField> + <descriptionField>CUSTOMERCODE_DISPLAY_fieldGroup</descriptionField> + <entityField>#ENTITY</entityField> + </cardViewTemplate> + <neonViewReference> + <name>df605bb6-5d18-4233-abc0-1da82e4910ca</name> + <entityField>OrgAddress_dfo</entityField> + <view>AddressList_view</view> + </neonViewReference> + <genericViewTemplate> + <name>OrgInfo_template</name> + <showDrawer v="true" /> + <entityField>#ENTITY</entityField> + <fields> + <entityFieldLink> + <name>4bad7219-1a3a-4e6e-ae5a-533d3acb6845</name> + <entityField>LANGUAGE</entityField> + </entityFieldLink> + <entityFieldLink> + <name>5a397737-2768-4e16-8c58-890b8a26b4a2</name> + <entityField>STATUS</entityField> + </entityFieldLink> + <entityFieldLink> + <name>89e9aa74-1568-4f74-b42a-a02b13752802</name> + <entityField>TYPE</entityField> + </entityFieldLink> + <entityFieldLink> + <name>180e8467-4eb2-4f89-a59f-ff76b8810925</name> + <entityField>INFO</entityField> + </entityFieldLink> + </fields> + </genericViewTemplate> + <neonViewReference> + <name>7b3f1253-f671-4cf4-83ec-81e229910014</name> + <entityField>OrgCommEmail_dfo</entityField> + <view>CommList_view</view> + </neonViewReference> + <neonViewReference> + <name>23f420cb-fd45-433f-b385-55a49e98744f</name> + <entityField>OrgCommPhone_dfo</entityField> + <view>CommList_view</view> + </neonViewReference> + <neonViewReference> + <name>c45d71cf-b81f-4d75-876d-7f9c26b1eb12</name> + <entityField>OrgCommOthers_dfo</entityField> + <view>CommList_view</view> + </neonViewReference> + </children> +</neonView> diff --git a/process/Comm_lib/Comm_lib.aod b/process/Comm_lib/Comm_lib.aod new file mode 100644 index 0000000000000000000000000000000000000000..21ab969d90c667d39fe448d4805b9a95d4994f69 --- /dev/null +++ b/process/Comm_lib/Comm_lib.aod @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<process xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.1.7" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/process/1.1.7"> + <name>Comm_lib</name> + <majorModelMode>DISTRIBUTED</majorModelMode> + <process>%aditoprj%/process/Comm_lib/process.js</process> +</process> diff --git a/process/Comm_lib/process.js b/process/Comm_lib/process.js new file mode 100644 index 0000000000000000000000000000000000000000..84b969d635c72e28ad7bffdd2f8b4a03424232b6 --- /dev/null +++ b/process/Comm_lib/process.js @@ -0,0 +1,65 @@ +import("system.translate"); +import("system.net"); +import("system.mail"); +import("system.cti"); + + +/** + * provides somehow static methods for validation of communication data + * do not create an instance of this + */ +function CommValidationUtil(){ +} + +/** + * creates a function depending on a given COMM-category (like PHONE, EMAIL, etc.) or null if no validation-function was defined for the given category + * @param {string} commCategory category that determines which function shall be created, e.g. "EMAIL" + * @return {function} function that receives the following arguments: + * <br/> - commAddress + * <br/> - extensions + * <br/>the function has to return null if everything is OK or a value with details if validation failed + */ +CommValidationUtil.makeValidationFn = function (commCategory){ + var callbackFn; + + switch (commCategory) { + case "EMAIL": + callbackFn = function (addrValue){ +// if (!mail.isValidMailAddress(addrValue)) //TODO: enable JDito-methods +// return translate.text("no valid mail-address format"); + return null; + } + break; + case "LINK": + callbackFn = function (addrValue){ +// if (!net.isValidUrl(addrValue, ["http", "https"]))//TODO: enable JDito-methods +// return translate.text("no valid format"); + return null; + } + break; + case "TELEPHONE": + callbackFn = function (addrValue, ext){ + var country = null; + if (addrValue[0] != "+") //if the number starts with a country-identifier (e.g. +49) no country needs to be specified + country = ext.countryCode; +// if (!cti.isValidPhoneNumber(addrValue, country))//TODO: enable JDito-methods +// return translate.text("no valid phone number"); + return null; + } + break; + default: + callbackFn = null; + break; + } + return callbackFn; +} + +/** + * returns a blueprint for validation extensions; these extensions are needed for validating comm data and can be passed to other functions + * @return {object} a object with properties that have a specific default value; normally you want to overwrite that value + */ +CommValidationUtil.getExtensionsBlueprint = function(){ + return { + countryCode: null + }; +} diff --git a/process/Keyword_lib/process.js b/process/Keyword_lib/process.js index 7e8781529f62f054c579424e158129a7a7a8a0c9..d018fbf41aa3d76b6cc9cfcd2b73a16276a8455e 100644 --- a/process/Keyword_lib/process.js +++ b/process/Keyword_lib/process.js @@ -1,352 +1,354 @@ -import("system.translate"); - -/** - * provides methods for interactions with keywords - */ -function KeywordUtils(){ - /** - * returns the default case for keyword-arrays (id and translated name) - * @param {String} keywordType specifies the type of the keyword and therefore the list elements; e.g. "COUNTRY" - * @return {Array} a 2D array in form of [["id1", "name1"], ["idN", "nameN"]] - * @example - * var kwdUtils, items; - * - * kwdUtils = new KeywordUtils(); - * items = kwdUtils.getStandardArray("ADDRESS.TYPE"); - * result.object(items); - */ - this.getStandardArray = function(keywordType){ - return this.createKeyword(keywordType).toArray(["id", "name"]); - } - - /** - * returns a specific name (translated) - this is normally the view-value - of a given keyword; - * <br/>if the key could not be found an empty string "" is returned - * @param {String} keywordType specifies the type of the keyword and therefore the list elements; e.g. "COUNTRY" - * @param {String} key id value of the keyword where the view-value shall be searched - * @return {String} representation of the translated name of the keyword-key - * @example - * var kwdUtils, histMedium; - * histMedium = vars.get("$field.MEDIUM"); - * if (histMedium){ - * kwdUtils = new KeywordUtils(); - * result.string(vars.get("$field.SUBJECT") + " (" + kwdUtils.getViewValue("HISTORY.MEDIUM", histMedium) + ")"); - * } - */ - this.getViewValue = function(keywordType, key){ - var k = this.createKeyword(keywordType); - return k.getPropForKey(key, "name") || ""; - } - - /** - * creates an object with methods for interacting with an specific keyword - * @param {String} keywordType specifies the type of the keyword and therefore the list elements; e.g. "COUNTRY" - * @return {Object} object with the following methods: - * <br/>- toArray - * <br/>- getPropForKey - * <br/>- getPropsForKey - */ - this.createKeyword = function(keywordType){//TODO: rename ot createKeywordObj? - var valueContainer, _toArrayFn, _getPropForKeyFn, _getPropsForKeyFn; - - switch (keywordType){ - case "RELATION.STATUS": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Inactive")) - ,createKeywordEntry("1", translate.text("Active")) - ,createKeywordEntry("2", translate.text("In review")) - ]); - break; - case "COUNTRY": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("DE", translate.text("Germany")) - ,createKeywordEntry("AT", translate.text("Austria")) - ,createKeywordEntry("CH", translate.text("Switzerland")) - ,createKeywordEntry("GB", translate.text("United Kingdom")) - ,createKeywordEntry("NO", translate.text("Norway")) - ]); - break; - case "LANGUAGE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("de", translate.text("German")) - ,createKeywordEntry("de-DE", translate.text("German (Germany)")) - ,createKeywordEntry("de-AT", translate.text("German (Austria)")) - ,createKeywordEntry("en", translate.text("English")) - ,createKeywordEntry("en-GB", translate.text("English (United Kingdom)")) - ,createKeywordEntry("no-NO", translate.text("Norwegian")) - ]); - break; - case "HISTORY.DIRECTION": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("i", translate.text("Incoming")) - ,createKeywordEntry("o", translate.text("Outgoing")) - ]); - break; - case "HISTORY.MEDIUM": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Visit")) - ,createKeywordEntry("1", translate.text("E-Mail")) - ,createKeywordEntry("2", translate.text("Phone")) - ,createKeywordEntry("3", translate.text("Internal")) - ,createKeywordEntry("4", translate.text("Online-Meeting")) - ]); - case "COMM.MEDIUM": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Mobile"), null, {category: "PHONE"}) - ,createKeywordEntry("1", translate.text("E-Mail"), null, {category: "EMAIL"}) - ,createKeywordEntry("2", translate.text("Phone"), null, {category: "PHONE"}) - ,createKeywordEntry("3", translate.text("Internet"), null, {category: "OTHER"}) - ]); - break; - case "ADDRESS.TYPE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Office address")) - ,createKeywordEntry("2", translate.text("Home address")) - ,createKeywordEntry("3", translate.text("Delivery address")) - ,createKeywordEntry("4", translate.text("Post office box")) - ]); - break; - case "ORG.TYPE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Customer")) - ,createKeywordEntry("1", translate.text("Prospect")) - ,createKeywordEntry("2", translate.text("Supplier")) - ,createKeywordEntry("3", translate.text("Other")) - ]); - break; - case "PERS.GENDER": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("f", translate.text("Female")) - ,createKeywordEntry("m", translate.text("Male")) - ,createKeywordEntry("o", translate.text("${GENDER_OTHER}")) - ]); - break; - case "CONTRACT.CONTRACTTYPE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Framework contract")) - ,createKeywordEntry("1", translate.text("Service contract")) - ,createKeywordEntry("2", translate.text("Maintenance contract")) - ]); - break; - case "CONTRACT.CONTRACTSTATUS": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Valid, unlimited")) - ,createKeywordEntry("1", translate.text("Valid, limited")) - ,createKeywordEntry("2", translate.text("Not signed yet")) - ,createKeywordEntry("3", translate.text("None, individual count")) - ,createKeywordEntry("4", translate.text("Cancelled")) - ]); - break; - case "CONTRACT.PAYMENT": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("0", translate.text("Annually")) - ,createKeywordEntry("1", translate.text("Semiannually")) - ,createKeywordEntry("2", translate.text("Quarterly")) - ]); - break; - case "GROUPCODE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Commodity group 1")) - ,createKeywordEntry("2", translate.text("Commodity group 2")) - ,createKeywordEntry("3", translate.text("Commodity group 3")) - ,createKeywordEntry("4", translate.text("Discount")) - ,createKeywordEntry("5", translate.text("Spare parts")) - ,createKeywordEntry("6", translate.text("Service")) - ]); - break; - case "UNIT": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Pieces")) - ,createKeywordEntry("2", translate.text("Kgs")) - ,createKeywordEntry("3", translate.text("Liter")) - ,createKeywordEntry("4", translate.text("Hours")) - ]); - break; - case "PRICELIST": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("${PRICELIST_DEFAULT}")) - ,createKeywordEntry("2", translate.text("Key account")) - ,createKeywordEntry("3", translate.text("Special price list1")) - ,createKeywordEntry("4", translate.text("${PRICELIST_SERVICE}")) - ]); - break; - case "CURRENCY": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("EUR")) - ,createKeywordEntry("2", translate.text("USD")) - ,createKeywordEntry("3", translate.text("CND")) - ,createKeywordEntry("4", translate.text("CHF")) - ]); - break; - case "STOCK.WAREHOUSE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Warehouse 1")) - ,createKeywordEntry("2", translate.text("Warehouse 2")) - ,createKeywordEntry("3", translate.text("Warehouse 3")) - ]); - break; - case "SALESPROJECT.STATUS": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Open")) - ,createKeywordEntry("2", translate.text("Postponed")) - ,createKeywordEntry("3", translate.text("Aborted")) - ,createKeywordEntry("4", translate.text("Partial order")) - ,createKeywordEntry("5", translate.text("Order")) - ,createKeywordEntry("6", translate.text("Lost")) - ]); - break; - case "SALESPROJECT.PHASE": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Project decision")) - ,createKeywordEntry("2", translate.text("Negotiation")) - ,createKeywordEntry("3", translate.text("Workshop")) - ,createKeywordEntry("4", translate.text("Presentation postprocessing")) - ,createKeywordEntry("5", translate.text("Presentation preparation")) - ,createKeywordEntry("6", translate.text("Statement given")) - ,createKeywordEntry("7", translate.text("Specifications in progress")) - ,createKeywordEntry("8", translate.text("Waiting for request")) - ,createKeywordEntry("9", translate.text("Lead")) - ]); - break; - case "OFFER.PROBABILITY": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("0 %"), null, {percentValue: 0}) - ,createKeywordEntry("2", translate.text("25 %"), null, {percentValue: 25}) - ,createKeywordEntry("3", translate.text("50 %"), null, {percentValue: 50}) - ,createKeywordEntry("4", translate.text("75 %"), null, {percentValue: 75}) - ,createKeywordEntry("5", translate.text("100 %"), null, {percentValue: 100}) - ]); - break; - case "OFFER.STATUS": - valueContainer = createKeywordEntriesContainer([ - createKeywordEntry("1", translate.text("Checked")) - ,createKeywordEntry("2", translate.text("Sent")) - ,createKeywordEntry("3", translate.text("Won")) - ,createKeywordEntry("4", translate.text("Lost")) - ]); - break; - default: - throw new Error(translate.withArguments("[%0]the given keyword \"%1\" has no match with the possible keywordlist", [ - arguments.callee.name, keywordType - ])); - break; - } - - - _getPropForKeyFn = function(key, field, isCustom) { - var keyObject; - if (isCustom) - keyObject = valueContainer[key]["customProperties"]; - else - keyObject = valueContainer[key]; - - if (keyObject == undefined) - return undefined; - return keyObject[field]; - }; - - _getPropsForKeyFn = function(key, fields) { - var keyObject, i, l, currentRow, currentField; - - keyObject = valueContainer[key]; - if (keyObject == undefined) - return [];//TODO: throw error instead? - l = fields.length; - currentRow = []; - for (i = 0; i < l; i++){ - currentField = fields[i]; - //check if the passed fieldnames match the existing fieldnames (<=> properties in the object) - //to prevent errors and unexpected behaviour - if (keyObject[currentField]) - currentRow.push(keyObject[currentField]); - else - currentRow.push(""); - } - return currentRow; - }; - - _toArrayFn = function(fields){ - var res, id, currentRow; - - res = []; - if (!fields) - fields = ["id", "name"]; - else if (typeof(fields) == "string"){ - for (id in valueContainer){ - res.push(_getPropForKeyFn(id, fields)); - } - return res; - } - - for (id in valueContainer){ - currentRow = _getPropsForKeyFn(id, fields); - res.push(currentRow); - } - return res; - }; - - return { - /** - * toArray - */ - toArray: _toArrayFn - ,getPropForKey: _getPropForKeyFn - ,getPropsForKey: _getPropsForKeyFn - ,filter: function (callbackFn, thisArg){ - for (id in valueContainer){ - if (false == callbackFn.call(thisArg, valueContainer[id].id, valueContainer[id].name, valueContainer[id].customProperties, - valueContainer[id], valueContainer)){ - delete valueContainer[id]; - } - } - return this; - } - }; - }; - - /** - * internal function for creating an object that represents a keyword entry - * @param {String} id represents the key of an entry; a KeywordEntriesContainer can contain the same key only once - * @param {String} name represents the translated name of an entry; this is in most cases the view-value - * @param {String} [description=""] description text for describing the keyword - * @param {Object} [customProperties=null] an Object with additional properties; these can be virtually anything - * @return {Object} object that represents a single keyword entry; normally severel entries are cumulated in a "keywordEntriesContainer" - */ - function createKeywordEntry(id, name, description, customProperties){ - //TODO: verify if mandatory-checks are really that usefull or can at least be made easier - if (!id) - throw new Error(translate.withArguments("the param \"%0\" in \"%1\" is mandatory and has to be set", [ - "id", arguments.callee.name - ])); - if (!name) - throw new Error(translate.withArguments("the param \"%0\" in \"%1\" is mandatory and has to be set", [ - "name", arguments.callee.name - ])); - - return { - id: id - ,name: name - ,description: description || "" - ,customProperties: customProperties - }; - } - - /** - * internal function for creating an object that represents a container of several keywordEntries - * @param {Array} keywordEntries an Array of keywordEntry-objects (as they are created by "createKeywordEntry" - * @return {Object} object that contains several keywordEntries - */ - function createKeywordEntriesContainer(keywordEntries){ - var res, i, l, id; - - res = {}; - for (i = 0, l = keywordEntries.length; i < l; i++){ - id = keywordEntries[i].id; - if (res[id] != undefined){ - throw new Error("the given id is not unique since it already exists"); - } - res[id] = keywordEntries[i]; - } - return res; - } +import("system.translate"); +import("system.neon"); + +/** + * provides methods for interactions with keywords + */ +function KeywordUtils(){ + /** + * returns the default case for keyword-arrays (id and translated name) + * @param {String} keywordType specifies the type of the keyword and therefore the list elements; e.g. "COUNTRY" + * @return {Array} a 2D array in form of [["id1", "name1"], ["idN", "nameN"]] + * @example + * var kwdUtils, items; + * + * kwdUtils = new KeywordUtils(); + * items = kwdUtils.getStandardArray("ADDRESS.TYPE"); + * result.object(items); + */ + this.getStandardArray = function(keywordType){ + return this.createKeyword(keywordType).toArray(["id", "name"]); + } + + /** + * returns a specific name (translated) - this is normally the view-value - of a given keyword; + * <br/>if the key could not be found an empty string "" is returned + * @param {String} keywordType specifies the type of the keyword and therefore the list elements; e.g. "COUNTRY" + * @param {String} key id value of the keyword where the view-value shall be searched + * @return {String} representation of the translated name of the keyword-key + * @example + * var kwdUtils, histMedium; + * histMedium = vars.get("$field.MEDIUM"); + * if (histMedium){ + * kwdUtils = new KeywordUtils(); + * result.string(vars.get("$field.SUBJECT") + " (" + kwdUtils.getViewValue("HISTORY.MEDIUM", histMedium) + ")"); + * } + */ + this.getViewValue = function(keywordType, key){ + var k = this.createKeyword(keywordType); + return k.getPropForKey(key, "name") || ""; + } + + /** + * creates an object with methods for interacting with an specific keyword + * @param {String} keywordType specifies the type of the keyword and therefore the list elements; e.g. "COUNTRY" + * @return {Object} object with the following methods: + * <br/>- toArray + * <br/>- getPropForKey + * <br/>- getPropsForKey + * <br/>- filter + */ + this.createKeyword = function(keywordType){//TODO: rename ot createKeywordObj? + var valueContainer, _toArrayFn, _getPropForKeyFn, _getPropsForKeyFn; + + switch (keywordType){ + case "RELATION.STATUS": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Inactive")) + ,createKeywordEntry("1", translate.text("Active")) + ,createKeywordEntry("2", translate.text("In review")) + ]); + break; + case "COUNTRY": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("DE", translate.text("Germany")) + ,createKeywordEntry("AT", translate.text("Austria")) + ,createKeywordEntry("CH", translate.text("Switzerland")) + ,createKeywordEntry("GB", translate.text("United Kingdom")) + ,createKeywordEntry("NO", translate.text("Norway")) + ]); + break; + case "LANGUAGE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("de", translate.text("German")) + ,createKeywordEntry("de-DE", translate.text("German (Germany)")) + ,createKeywordEntry("de-AT", translate.text("German (Austria)")) + ,createKeywordEntry("en", translate.text("English")) + ,createKeywordEntry("en-GB", translate.text("English (United Kingdom)")) + ,createKeywordEntry("no-NO", translate.text("Norwegian")) + ]); + break; + case "HISTORY.DIRECTION": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("i", translate.text("Incoming")) + ,createKeywordEntry("o", translate.text("Outgoing")) + ]); + break; + case "HISTORY.MEDIUM": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Visit")) + ,createKeywordEntry("1", translate.text("E-Mail")) + ,createKeywordEntry("2", translate.text("Phone")) + ,createKeywordEntry("3", translate.text("Internal")) + ,createKeywordEntry("4", translate.text("Online-Meeting")) + ]); + case "COMM.MEDIUM": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Mobile"), null, {category: "PHONE", contentType: "TELEPHONE"}) + ,createKeywordEntry("1", translate.text("E-Mail"), null, {category: "EMAIL", contentType: "EMAIL"}) + ,createKeywordEntry("2", translate.text("Phone"), null, {category: "PHONE", contentType: "TELEPHONE"}) + ,createKeywordEntry("3", translate.text("Internet"), null, {category: "OTHER", contentType: "LINK"}) + ]); + break; + case "ADDRESS.TYPE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Office address")) + ,createKeywordEntry("2", translate.text("Home address")) + ,createKeywordEntry("3", translate.text("Delivery address")) + ,createKeywordEntry("4", translate.text("Post office box")) + ]); + break; + case "ORG.TYPE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Customer")) + ,createKeywordEntry("1", translate.text("Prospect")) + ,createKeywordEntry("2", translate.text("Supplier")) + ,createKeywordEntry("3", translate.text("Other"))//TODO: key as ${} + ]); + break; + case "PERS.GENDER": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("f", translate.text("Female")) + ,createKeywordEntry("m", translate.text("Male")) + ,createKeywordEntry("o", translate.text("${GENDER_OTHER}")) + ]); + break; + case "CONTRACT.CONTRACTTYPE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Framework contract")) + ,createKeywordEntry("1", translate.text("Service contract")) + ,createKeywordEntry("2", translate.text("Maintenance contract")) + ]); + break; + case "CONTRACT.CONTRACTSTATUS": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Valid, unlimited")) + ,createKeywordEntry("1", translate.text("Valid, limited")) + ,createKeywordEntry("2", translate.text("Not signed yet")) + ,createKeywordEntry("3", translate.text("None, individual count")) + ,createKeywordEntry("4", translate.text("Cancelled")) + ]); + break; + case "CONTRACT.PAYMENT": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("0", translate.text("Annually")) + ,createKeywordEntry("1", translate.text("Semiannually")) + ,createKeywordEntry("2", translate.text("Quarterly")) + ]); + break; + case "GROUPCODE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Commodity group 1")) + ,createKeywordEntry("2", translate.text("Commodity group 2")) + ,createKeywordEntry("3", translate.text("Commodity group 3")) + ,createKeywordEntry("4", translate.text("Discount")) + ,createKeywordEntry("5", translate.text("Spare parts")) + ,createKeywordEntry("6", translate.text("Service")) + ]); + break; + case "UNIT": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Pieces")) + ,createKeywordEntry("2", translate.text("Kgs")) + ,createKeywordEntry("3", translate.text("Liter")) + ,createKeywordEntry("4", translate.text("Hours")) + ]); + break; + case "PRICELIST": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("${PRICELIST_DEFAULT}")) + ,createKeywordEntry("2", translate.text("Key account")) + ,createKeywordEntry("3", translate.text("Special price list1")) + ,createKeywordEntry("4", translate.text("${PRICELIST_SERVICE}")) + ]); + break; + case "CURRENCY": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("EUR")) + ,createKeywordEntry("2", translate.text("USD")) + ,createKeywordEntry("3", translate.text("CND")) + ,createKeywordEntry("4", translate.text("CHF")) + ]); + break; + case "STOCK.WAREHOUSE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Warehouse 1")) + ,createKeywordEntry("2", translate.text("Warehouse 2")) + ,createKeywordEntry("3", translate.text("Warehouse 3")) + ]); + break; + case "SALESPROJECT.STATUS": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Open")) + ,createKeywordEntry("2", translate.text("Postponed")) + ,createKeywordEntry("3", translate.text("Aborted")) + ,createKeywordEntry("4", translate.text("Partial order")) + ,createKeywordEntry("5", translate.text("Order")) + ,createKeywordEntry("6", translate.text("Lost")) + ]); + break; + case "SALESPROJECT.PHASE": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Project decision")) + ,createKeywordEntry("2", translate.text("Negotiation")) + ,createKeywordEntry("3", translate.text("Workshop")) + ,createKeywordEntry("4", translate.text("Presentation postprocessing")) + ,createKeywordEntry("5", translate.text("Presentation preparation")) + ,createKeywordEntry("6", translate.text("Statement given")) + ,createKeywordEntry("7", translate.text("Specifications in progress")) + ,createKeywordEntry("8", translate.text("Waiting for request")) + ,createKeywordEntry("9", translate.text("Lead")) + ]); + break; + case "OFFER.PROBABILITY": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("0 %"), null, {percentValue: 0}) + ,createKeywordEntry("2", translate.text("25 %"), null, {percentValue: 25}) + ,createKeywordEntry("3", translate.text("50 %"), null, {percentValue: 50}) + ,createKeywordEntry("4", translate.text("75 %"), null, {percentValue: 75}) + ,createKeywordEntry("5", translate.text("100 %"), null, {percentValue: 100}) + ]); + break; + case "OFFER.STATUS": + valueContainer = createKeywordEntriesContainer([ + createKeywordEntry("1", translate.text("Checked")) + ,createKeywordEntry("2", translate.text("Sent")) + ,createKeywordEntry("3", translate.text("Won")) + ,createKeywordEntry("4", translate.text("Lost")) + ]); + break; + default: + throw new Error(translate.withArguments("[%0]the given keyword \"%1\" has no match with the possible keywordlist", [ + arguments.callee.name, keywordType + ])); + break; + } + + + _getPropForKeyFn = function(key, field, isCustom) { + var keyObject; + if (isCustom) + keyObject = valueContainer[key]["customProperties"]; + else + keyObject = valueContainer[key]; + + if (keyObject == undefined) + return undefined; + return keyObject[field]; + }; + + _getPropsForKeyFn = function(key, fields) { + var keyObject, i, l, currentRow, currentField; + + keyObject = valueContainer[key]; + if (keyObject == undefined) + return [];//TODO: throw error instead? + l = fields.length; + currentRow = []; + for (i = 0; i < l; i++){ + currentField = fields[i]; + //check if the passed fieldnames match the existing fieldnames (<=> properties in the object) + //to prevent errors and unexpected behaviour + if (keyObject[currentField]) + currentRow.push(keyObject[currentField]); + else + currentRow.push(""); + } + return currentRow; + }; + + _toArrayFn = function(fields){ + var res, id, currentRow; + + res = []; + if (!fields) + fields = ["id", "name"]; + else if (typeof(fields) == "string"){ + for (id in valueContainer){ + res.push(_getPropForKeyFn(id, fields)); + } + return res; + } + + for (id in valueContainer){ + currentRow = _getPropsForKeyFn(id, fields); + res.push(currentRow); + } + return res; + }; + + return { + /** + * toArray + */ + toArray: _toArrayFn + ,getPropForKey: _getPropForKeyFn + ,getPropsForKey: _getPropsForKeyFn + ,filter: function (callbackFn, thisArg){ + for (id in valueContainer){ + if (false == callbackFn.call(thisArg, valueContainer[id].id, valueContainer[id].name, valueContainer[id].customProperties, + valueContainer[id], valueContainer)){ + delete valueContainer[id]; + } + } + return this; + } + }; + }; + + /** + * internal function for creating an object that represents a keyword entry + * @param {String} id represents the key of an entry; a KeywordEntriesContainer can contain the same key only once + * @param {String} name represents the translated name of an entry; this is in most cases the view-value + * @param {String} [description=""] description text for describing the keyword + * @param {Object} [customProperties=null] an Object with additional properties; these can be virtually anything + * @return {Object} object that represents a single keyword entry; normally severel entries are cumulated in a "keywordEntriesContainer" + */ + function createKeywordEntry(id, name, description, customProperties){ + //TODO: verify if mandatory-checks are really that usefull or can at least be made easier + if (!id) + throw new Error(translate.withArguments("the param \"%0\" in \"%1\" is mandatory and has to be set", [ + "id", arguments.callee.name + ])); + if (!name) + throw new Error(translate.withArguments("the param \"%0\" in \"%1\" is mandatory and has to be set", [ + "name", arguments.callee.name + ])); + + return { + id: id + ,name: name + ,description: description || "" + ,customProperties: customProperties + }; + } + + /** + * internal function for creating an object that represents a container of several keywordEntries + * @param {Array} keywordEntries an Array of keywordEntry-objects (as they are created by "createKeywordEntry" + * @return {Object} object that contains several keywordEntries + */ + function createKeywordEntriesContainer(keywordEntries){ + var res, i, l, id; + + res = {}; + for (i = 0, l = keywordEntries.length; i < l; i++){ + id = keywordEntries[i].id; + if (res[id] != undefined){ + throw new Error("the given id is not unique since it already exists"); + } + res[id] = keywordEntries[i]; + } + return res; + } } \ No newline at end of file diff --git a/process/Sql_lib/process.js b/process/Sql_lib/process.js index 9187a8f49e56fa987f4fb7cb83c30a79153dfda4..4181790956d0d67fc930d95ce5d5e75d4ad2f20e 100644 --- a/process/Sql_lib/process.js +++ b/process/Sql_lib/process.js @@ -4,7 +4,8 @@ import("system.db"); import("system.datetime"); import("system.tools"); import("system.SQLTYPES"); -import("Util_lib") +import("system.text"); +import("Util_lib"); /** * Object for easier handling of conditions; @@ -12,8 +13,10 @@ import("Util_lib") * you don't need to append a "1=1" condition or similar; * @example //TODO: add missing example */ -function SqlCondition(){ +function SqlCondition(alias){ this._sqlStorage = ""; + this.preparedValues = []; + this.alias = alias; } /** * append with SQL-and; no paranthesize of existing conditions is done @@ -28,6 +31,22 @@ SqlCondition.prototype.and = function(cond){ this._sqlStorage += cond; return this; } + +/** + * same as the "and"-function but with preparedStatement functionality + * @param {String} field the database field as "tablename.columnname"; e.g. "ORG.NAME" + * @param {String} cond the strucutre of the SQL condition as preparedString, you can use a number sign "#" as placeholder for you fieldname; + * e.g. "# > ?"; escaping the number sign is possible with a backslash "\" + * @param {String} value the value that shall be set into the prepared statement + * @param {Numeric} [fieldType] SQL-column-type; if the fieldType is not given it's loaded automatically; + * please note that this can be a performace issue if it happens a lot of times (e.g. in aloop) + * @return {Object} current SqlCondition-object + */ +SqlCondition.prototype.andPrepare = function(field, cond, value, fieldType){ + cond = this._prepare(field, cond, value, fieldType); + return this.and(cond); +} + /** * append with SQL-or; Also paranthesize the existing conditions * @param {String} cond the condition string which shall be appended @@ -42,6 +61,21 @@ SqlCondition.prototype.or = function(cond){ this._sqlStorage = cond; return this; } + +/** + * same as the "or"-function but with preparedStatement functionality + * @param {String} field the database field as "tablename.columnname"; e.g. "ORG.NAME" + * @param {String} cond the strucutre of the SQL condition as preparedString, you can use a number sign "#" as placeholder for you fieldname; + * e.g. "# > ?"; escaping the number sign is possible with a backslash "\" + * @param {String} value the value that shall be set into the prepared statement + * @param {Numeric} [fieldType] SQL-column-type; if the fieldType is not given it's loaded automatically; + * please note that this can be a performace issue if it happens a lot of times (e.g. in aloop) + * @return {Object} current SqlCondition-object + */ +SqlCondition.prototype.orPrepare = function(field, cond, value, fieldType){ + cond = this._prepare(field, cond, value, fieldType); + return this.or(cond); +} /** * ready to use string; does not contain a where keyword at the beginning * @param {String} alternativeCond condition that is returned when nothing has been appended @@ -66,6 +100,44 @@ SqlCondition.prototype.toWhereString = function(alternativeCond){ return cond; } +/** + * hidden function for composing preparedStatements + * @param {String} field the database field as "tablename.columnname"; e.g. "ORG.NAME" + * @param {String} cond the strucutre of the SQL condition as preparedString, you can use a number sign "#" as placeholder for you fieldname; + * e.g. "# > ?"; escaping the number sign is possible with a backslash "\" + * @param {String} value the value that shall be set into the prepared statement + * @param {Numeric} [fieldType] SQL-column-type; if the fieldType is not given it's loaded automatically; + * please note that this can be a performace issue if it happens a lot of times (e.g. in aloop) + * @return {String} the replaced SQL-condition string (replace # by the fieldname) + */ +SqlCondition.prototype._prepare = function(field, cond, value, fieldType){ + //this function looks more complex (and slower) than it actually is + /* the following regex looks like this after javascript-escaping of the backslash: (?<!\\)((?:\\\\)*)# + the regexp searches for the unescaped character and these characters are replaced by the field name + + examples: + --------------------- + | # --match | + | \# --no-match | + | \\# --match | + | \\\# --no-match | + | \\\\# --match | + --------------------- + */ + //use replaceAll because it's faster and supports negative lookbehinds + cond = text.replaceAll(cond, { + //manually readd the replaced backslashes by using a group reference, because they a part of the match and therefore replaced by "replaceAll" + //since the field COULD contain already a group reference (I think this is extremely uncommon; + //probably that never happens but better stay save): escape that references within the fieldname + "(?<!\\\\)((?:\\\\\\\\)*)#": "$1" + text.replaceAll(field, {"$1": "\\$1"}), + //now that we've replaced the correct field placeholder let's replace the escaped number sign "\#" to a normal number sign "#" + "\\\\#": "#" + }); + type = fieldType || SqlUtils.getSingleColumnType(field, undefined, this.alias); + this.preparedValues.push([value.toString(), type]); + return cond; +} + function SqlMaskingUtils(){ //TODO: use callbacks for different handling? /** @@ -218,6 +290,42 @@ function SqlMaskingUtils(){ } } +function SqlUtils(){ +} + +SqlUtils.getSingleColumnType = function(fieldOrTableName, columnName, alias) +{ + var tableName, fieldVarType; + if (columnName == undefined){ + fieldVarType = typeof(fieldOrTableName); + if (fieldVarType == "string") + fieldOrTableName = text.split(fieldOrTableName, "\\."); + else if (fieldVarType != "object"){ + throw new TypeError();//TODO: add message + } + + if (fieldOrTableName.hasOwnProperty("length") && fieldOrTableName.length == 2) + { + tableName = fieldOrTableName[0]; + columnName = fieldOrTableName[1]; + } + else + throw new TypeError();//TODO: add message + } + else + tableName = fieldOrTableName; + + if (typeof(columnName) != "string") + throw new TypeError();//TODO: add message + if (typeof(tableName) != "string") + throw new TypeError();//TODO: add message + + if (alias == undefined) + alias = db.getCurrentAlias(); + + return db.getColumnTypes(tableName, [columnName], alias)[0]; +} + /** *Class containing utilities for SQL *@deprecated use SqlMaskingUtils