[#183] better handling of rule INPUT and OUTPUT variables

With this change, global_vars is deprecated and replaced with
irods_rule_vars, which is available in more contexts.

Author: SwooshyCueb

README.md

@@ -134,9 +134,10 @@ Aug  8 20:57:43 pid:23802 NOTICE: writeLine: inString = PYTHON - acPostProcForPu
 
 # Python globals and built-in modules
 These built-in objects are set up at plugin initialization time and available in the python interpreter that loads `core.py` or, as the case may be, the Python rule file:
-   - `global_vars` - a dictionary for accessing variables of the form `*var` from the `INPUT` line, if present.
+   - `irods_rule_vars` - a dictionary for accessing variables of the form `*var` from the `INPUT` line, if present.
    - `irods_types` - a module containing common struct types used for communicating with microservices.
    - `irods_errors` - a module mapping well-known iRODS error names to their corresponding integer values.
+   - `global_vars` - deprecated alias for `irods_rule_vars`; only available in some contexts. Will be removed in a future release.
 
 By using the `irods_errors` built-in, policy may indicate how the framework is to continue through the use of a symbolic name, rather than a cryptic number reference:
 ```
@@ -165,7 +166,7 @@ def testRule(rule_args, callback, rei):
 and a rule script file (named `call_testRule.r`) which calls `testRule` with a data path argument:
 ```
 def main(_,callback,rei):
-  data_path = global_vars[ '*dataPath' ][1:-1]
+  data_path = irods_rule_vars[ '*dataPath' ][1:-1]
   retval = callback.testRule( data_path )
   callback.writeLine( "stdout", retval['arguments'][0])
 INPUT *dataPath=""

python_rules/rulegenerateBagIt.r

@@ -1,6 +1,6 @@
 def main(rule_args, callback, rei):
-    bagIt_data = global_vars['*BAGITDATA'][1:-1]
-    new_bagIt_root = global_vars['*NEWBAGITROOT'][1:-1]
+    bagIt_data = irods_rule_vars['*BAGITDATA'][1:-1]
+    new_bagIt_root = irods_rule_vars['*NEWBAGITROOT'][1:-1]
 
     print_size = 0
     print_unit = ''

python_rules/rulemsiAddConditionToGenQuery.r

@@ -1,8 +1,8 @@
 def main(rule_args, callback, rei):
-    select = global_vars['*Select'][1:-1]
-    attribute = global_vars['*Attribute'][1:-1]
-    operator = global_vars['*Operator'][1:-1]
-    value = global_vars['*Value'][1:-1]
+    select = irods_rule_vars['*Select'][1:-1]
+    attribute = irods_rule_vars['*Attribute'][1:-1]
+    operator = irods_rule_vars['*Operator'][1:-1]
+    value = irods_rule_vars['*Value'][1:-1]
 
     ret_val = {}
 

python_rules/rulemsiAddKeyValToMspStr.r

@@ -1,6 +1,6 @@
 def main(rule_args, callback, rei):
-    attr_name = global_vars['*AttrName'][1:-1]
-    attr_value = global_vars['*AttrValue'][1:-1]
+    attr_name = irods_rule_vars['*AttrName'][1:-1]
+    attr_value = irods_rule_vars['*AttrValue'][1:-1]
 
     out_str = '='.join([attr_name, attr_value])
 

python_rules/rulemsiAddSelectFieldToGenQuery.r

@@ -1,7 +1,7 @@
 def main(rule_args, callback, rei):
-    select = global_vars['*Select'][1:-1]
-    select_add = global_vars['*SelectAdd'][1:-1]
-    fcn = global_vars['*Function'][1:-1]
+    select = irods_rule_vars['*Select'][1:-1]
+    select_add = irods_rule_vars['*SelectAdd'][1:-1]
+    fcn = irods_rule_vars['*Function'][1:-1]
 
     # Initial select is on COLL_NAME
     ret_val = callback.msiMakeGenQuery(select, "COLL_NAME like '/tempZone/home/rods/%%'", irods_types.GenQueryInp())

python_rules/rulemsiCheckAccess.r

@@ -1,6 +1,6 @@
 def main(rule_args, callback, rei):
-    path = global_vars['*Path'][1:-1]
-    acl = global_vars['*Acl'][1:-1]
+    path = irods_rule_vars['*Path'][1:-1]
+    acl = irods_rule_vars['*Acl'][1:-1]
 
     ret_val = callback.msiCheckAccess(path, acl, 0)
     result = ret_val['arguments'][2]

python_rules/rulemsiCollCreate.r

@@ -1,5 +1,5 @@
 def main(rule_args, callback, rei):
-    path = global_vars['*Path'][1:-1]
+    path = irods_rule_vars['*Path'][1:-1]
 
     callback.msiCollCreate(path, '0', 0)
 

python_rules/rulemsiCollRsync.r

@@ -1,7 +1,7 @@
 def main(rule_args, callback, rei):
-    src_coll = global_vars['*srcColl'][1:-1]
-    dest_coll = global_vars['*destColl'][1:-1]
-    resource = global_vars['*Resource'][1:-1]
+    src_coll = irods_rule_vars['*srcColl'][1:-1]
+    dest_coll = irods_rule_vars['*destColl'][1:-1]
+    resource = irods_rule_vars['*Resource'][1:-1]
 
     callback.msiCollRsync(src_coll, dest_coll, resource, 'IRODS_TO_IRODS', 0)
 

python_rules/rulemsiDataObjChksum.r

@@ -1,6 +1,6 @@
 def main(rule_args, callback, rei):
-    data_object = global_vars['*dataObject'][1:-1]
-    flags = global_vars['*Flags'][1:-1]
+    data_object = irods_rule_vars['*dataObject'][1:-1]
+    flags = irods_rule_vars['*Flags'][1:-1]
 
     import os
     (coll, file) = os.path.split(data_object)

python_rules/rulemsiDataObjClose.r

@@ -1,7 +1,7 @@
 def main(rule_args, callback, rei):
-    resc = global_vars['*Resc'][1:-1]
-    obj = global_vars['*Obj'][1:-1]
-    oflags = global_vars['*OFlags'][1:-1]
+    resc = irods_rule_vars['*Resc'][1:-1]
+    obj = irods_rule_vars['*Obj'][1:-1]
+    oflags = irods_rule_vars['*OFlags'][1:-1]
 
     ret_val = callback.msiDataObjCreate(obj, oflags, 0)
     file_desc = ret_val['arguments'][2]