Merge pull request #152 from domdinicola/feature/camlquery_builder

helper: camlquery builder

Author: vgrem

office365/sharepoint/helpers/__init__.py

@@ -0,0 +1,79 @@
+import logging
+
+from office365.sharepoint.caml_query import CamlQuery
+from office365.sharepoint.helpers.utils import to_camel
+
+logger = logging.getLogger(__name__)
+
+
+def recursive_builder(queries, operator='And'):
+    if queries:
+        query = queries.pop()
+        if len(queries) == 0:
+            return query
+        elif len(queries) == 1:
+            last_query = queries.pop()
+            return f'<{operator}>' + query + last_query + f'</{operator}>'
+        else:
+            return f'<{operator}>' + query + recursive_builder(queries) + f'</{operator}>'
+    return ''
+
+
+class CamlQueryBuilder:
+    date_operators = ['Geq', 'Gt', 'Leq', 'Lt']
+    mapping_operator = {
+        'gte': 'Geq',
+        'gt': 'Gt',
+        'lte': 'Leq',
+        'lt': 'Lt',
+        'not': 'Neq',
+        'contains': 'Contains',
+        'eq': 'Eq',
+    }
+
+    filters = {}
+
+    def __init__(self, filters, scope=None):
+        super().__init__()
+        self.scope = scope
+
+        if filters:
+            self.filters = filters
+
+    def create_query(self):
+        where_condition = ''
+
+        if self.filters.keys():
+            filter_queries = []
+            for filter_name, filter_value in self.filters.items():
+                querystring_operator = filter_name.split('__')[-1]
+                operator = self.mapping_operator.get(querystring_operator, 'Eq')
+
+                filter_name = to_camel(filter_name.split('__')[0])
+                if operator in self.date_operators:
+                    column_type, value = 'DateTime', "{}T00:00:00Z".format(filter_value)  # 2016-03-26
+                    query = '<{}><FieldRef Name="{}" /><Value Type="{}">{}</Value></{}>'.format(
+                        operator, filter_name, column_type, value, operator)
+                elif operator == 'Contains':
+                    column_type, values = 'Note', filter_value
+                    query = '<{}><FieldRef Name="{}" /><Value Type="{}">{}</Value></{}>'.format(
+                            operator, filter_name, column_type, filter_value, operator)
+                else:
+                    column_type, values = 'Text', filter_value.split(',')
+                    query = ''
+                    for value in values:
+                        query = query + '<{}><FieldRef Name="{}" /><Value Type="{}">{}</Value></{}>'.format(
+                            operator, filter_name, column_type, value, operator)
+                    if len(values) > 1:
+                        query = f'<Or>{query}</Or>'
+                filter_queries.append(query)
+            where_condition = recursive_builder(filter_queries)
+            if len(filter_queries) > 1:
+                where_condition = f"<And>{where_condition}</And>"
+
+        scope = f' Scope="{self.scope}"' if self.scope else ''
+        query = f'<View{scope}><Query><Where>{where_condition}</Where></Query></View>'
+        return query
+
+    def get_query(self):
+        return CamlQuery.create_custom_query(self.create_query())

office365/sharepoint/helpers/camlquery_builder.py

@@ -1,10 +1,8 @@
 import logging
 
-logger = logging.getLogger(__name__)
-
+from office365.sharepoint.helpers.utils import to_camel
 
-def to_camel(snake_str):
-    return ''.join(x.title() for x in snake_str.split('_'))
+logger = logging.getLogger(__name__)
 
 
 class QueryStringBuilder:

office365/sharepoint/querystring_builder.py renamed to office365/sharepoint/helpers/querystring_builder.py

@@ -0,0 +1,2 @@
+def to_camel(snake_str):
+    return ''.join(x.title() for x in snake_str.split('_'))