[#364] allow ADMIN_KW in all metadata operations

Author: d-w-moore

irods/manager/metadata_manager.py

@@ -1,6 +1,7 @@
 from __future__ import print_function
 from __future__ import absolute_import
 import logging
+import copy
 from os.path import dirname, basename
 
 from irods.manager import Manager
@@ -9,6 +10,7 @@
 from irods.models import (DataObject, Collection, Resource,
                           User, DataObjectMeta, CollectionMeta, ResourceMeta, UserMeta)
 from irods.meta import iRODSMeta, AVUOperation
+import irods.keywords as kw
 
 
 logger = logging.getLogger(__name__)
@@ -19,6 +21,19 @@ class InvalidAtomicAVURequest(Exception): pass
 
 class MetadataManager(Manager):
 
+    __kw = {}  # default (empty) keywords
+
+    def _updated_keywords(self,opts):
+        kw_ = self.__kw.copy()
+        kw_.update(opts)
+        return kw_
+
+    def __call__(self, admin = False, **irods_kw_opt):
+        x = copy.copy(self)
+        irods_kw_opt.update([() if not admin else (kw.ADMIN_KW,"")])
+        x.__kw = irods_kw_opt
+        return x
+
     @staticmethod
     def _model_class_to_resource_type(model_cls):
         return {
@@ -63,7 +78,7 @@ def get(self, model_cls, path):
             avu_id=row[model.id]
         ) for row in results]
 
-    def add(self, model_cls, path, meta):
+    def add(self, model_cls, path, meta, **opts):
         # Avoid sending request with empty argument(s)
         if not(len(path) and len(meta.name) and len(meta.value)):
             raise ValueError('Empty value in ' + repr(meta))
@@ -75,7 +90,8 @@ def add(self, model_cls, path, meta):
             path,
             meta.name,
             meta.value,
-            meta.units
+            meta.units,
+            **self._updated_keywords(opts)
         )
         request = iRODSMessage("RODS_API_REQ", msg=message_body,
                                int_info=api_number['MOD_AVU_METADATA_AN'])
@@ -84,15 +100,16 @@ def add(self, model_cls, path, meta):
             response = conn.recv()
         logger.debug(response.int_info)
 
-    def remove(self, model_cls, path, meta):
+    def remove(self, model_cls, path, meta, **opts):
         resource_type = self._model_class_to_resource_type(model_cls)
         message_body = session_cache(MetadataRequest,self.sess)(
             "rm",
             "-" + resource_type,
             path,
             meta.name,
             meta.value,
-            meta.units
+            meta.units,
+            **self._updated_keywords(opts)
         )
         request = iRODSMessage("RODS_API_REQ", msg=message_body,
                                int_info=api_number['MOD_AVU_METADATA_AN'])
@@ -101,15 +118,16 @@ def remove(self, model_cls, path, meta):
             response = conn.recv()
         logger.debug(response.int_info)
 
-    def copy(self, src_model_cls, dest_model_cls, src, dest):
+    def copy(self, src_model_cls, dest_model_cls, src, dest, **opts):
         src_resource_type = self._model_class_to_resource_type(src_model_cls)
         dest_resource_type = self._model_class_to_resource_type(dest_model_cls)
         message_body = session_cache(MetadataRequest,self.sess)(
             "cp",
             "-" + src_resource_type,
             "-" + dest_resource_type,
             src,
-            dest
+            dest,
+            **self._updated_keywords(opts)
         )
         request = iRODSMessage("RODS_API_REQ", msg=message_body,
                                int_info=api_number['MOD_AVU_METADATA_AN'])
@@ -119,15 +137,16 @@ def copy(self, src_model_cls, dest_model_cls, src, dest):
             response = conn.recv()
         logger.debug(response.int_info)
 
-    def set(self, model_cls, path, meta):
+    def set(self, model_cls, path, meta, **opts):
         resource_type = self._model_class_to_resource_type(model_cls)
         message_body = session_cache(MetadataRequest,self.sess)(
             "set",
             "-" + resource_type,
             path,
             meta.name,
             meta.value,
-            meta.units
+            meta.units,
+            **self._updated_keywords(opts)
         )
         request = iRODSMessage("RODS_API_REQ", msg=message_body,
                                int_info=api_number['MOD_AVU_METADATA_AN'])

irods/meta.py

@@ -62,8 +62,15 @@ def __init__(self, operation, avu, **kw):
             setattr(self,atr,locals()[atr])
 
 
+import copy
+
 class iRODSMetaCollection(object):
 
+    def __call__(self, admin = False, **opts):
+        x = copy.copy(self)
+        x._manager = (x._manager)(admin, **opts)
+        return x
+
     def __init__(self, manager, model_cls, path):
         self._manager = manager
         self._model_cls = model_cls
@@ -103,28 +110,28 @@ def apply_atomic_operations(self, *avu_ops):
         self._manager.apply_atomic_operations(self._model_cls, self._path, *avu_ops)
         self._reset_metadata()
 
-    def set(self, *args):
+    def set(self, *args, **opts):
         """
         Set as iRODSMeta to a key
         """
         meta = self._get_meta(*args)
-        self._manager.set(self._model_cls, self._path, meta)
+        self._manager.set(self._model_cls, self._path, meta, **opts)
         self._reset_metadata()
 
-    def add(self, *args):
+    def add(self, *args, **opts):
         """
         Add as iRODSMeta to a key
         """
         meta = self._get_meta(*args)
-        self._manager.add(self._model_cls, self._path, meta)
+        self._manager.add(self._model_cls, self._path, meta, **opts)
         self._reset_metadata()
 
-    def remove(self, *args):
+    def remove(self, *args, **opts):
         """
         Removes an iRODSMeta
         """
         meta = self._get_meta(*args)
-        self._manager.remove(self._model_cls, self._path, meta)
+        self._manager.remove(self._model_cls, self._path, meta, **opts)
         self._reset_metadata()
 
     def items(self):
@@ -179,7 +186,7 @@ def __contains__(self, key):
         values = self.get_all(key)
         return len(values) > 0
 
-    def remove_all(self):
+    def remove_all(self, **opts):
         for meta in self._meta:
-            self._manager.remove(self._model_cls, self._path, meta)
+            self._manager.remove(self._model_cls, self._path, meta, **opts)
         self._reset_metadata()