chg: [cookiejar] import/export cookiejar from/to JSON

Author: Terrtia

bin/lib/crawlers.py

@@ -1196,6 +1196,86 @@ def api_check_cookiejar_access_acl(cookiejar_uuid, user_org, user_id, user_role,
 
 ####  API  ####
 
+def api_export_cookiejar_json(user_org, user_id, user_role, cookiejar_uuid):
+    resp = api_check_cookiejar_access_acl(cookiejar_uuid, user_org, user_id, user_role, 'view')
+    if resp:
+        return resp
+    cookiejar = Cookiejar(cookiejar_uuid)
+    storage = cookiejar.get_local_storage()
+    if not isinstance(storage, dict):
+        storage = {}
+    storage['cookies'] = cookiejar.get_cookies()
+
+    return {
+        'uuid': cookiejar_uuid,
+        'description': cookiejar.get_description(),
+        'level': cookiejar.get_level(),
+        'storage': storage,
+    }, 200
+
+
+def _import_storage_in_cookiejar(cookiejar, storage):
+    cookies = storage.get('cookies', [])
+    origins = storage.get('origins')
+
+    if not cookies and not origins:
+        return {'error': 'No cookies or local storage to import'}, 400
+
+    cookiejar.delete_cookies()
+    cookiejar.delete_local_storage()
+    cookiejar.set_cookies(cookies)
+    cookiejar.set_local_storage(storage)
+
+
+def _get_storage_from_cookiejar_json(data):
+    storage = data.get('storage')
+    if storage is None:
+        storage = data.get('local_storage', data)
+        if isinstance(storage, dict) and 'cookies' not in storage and 'cookies' in data:
+            storage['cookies'] = data.get('cookies', [])
+    if not isinstance(storage, dict):
+        return None
+    return storage
+
+
+def api_import_cookiejar_json(user_org, user_id, user_role, cookiejar_uuid, data):
+    resp = api_check_cookiejar_access_acl(cookiejar_uuid, user_org, user_id, user_role, 'edit')
+    if resp:
+        return resp
+    storage = _get_storage_from_cookiejar_json(data)
+    if storage is None:
+        return {'error': 'invalid cookiejar JSON storage'}, 400
+    res = _import_storage_in_cookiejar(Cookiejar(cookiejar_uuid), storage)
+    if res:
+        return res
+    return {'cookiejar_uuid': cookiejar_uuid}, 200
+
+
+def api_create_cookiejar_from_json(user_org, user_id, data):
+    storage = _get_storage_from_cookiejar_json(data)
+    if storage is None:
+        return {'error': 'invalid cookiejar JSON storage'}, 400
+
+    level = data.get('level', 1)
+    try:
+        level = int(level)
+    except (TypeError, ValueError):
+        level = 1
+    if level not in range(0, 3):
+        level = 1
+
+    description = data.get('description')
+    if not description:
+        description = 'imported from cookiejar JSON'
+
+    cookiejar_uuid = create_cookiejar(user_org, user_id, description, level, None)
+    res = _import_storage_in_cookiejar(Cookiejar(cookiejar_uuid), storage)
+    if res:
+        Cookiejar(cookiejar_uuid).delete()
+        return res
+    return {'cookiejar_uuid': cookiejar_uuid}, 200
+
+
 def api_import_lacus_cookiejar(user_org, user_id, data, cookiejar_uuid=None):
     url = data.get('url')
     storage = data.get('storage')
@@ -1207,11 +1287,6 @@ def api_import_lacus_cookiejar(user_org, user_id, data, cookiejar_uuid=None):
     cookiejar_uuid = data.get('uuid')
     level = data.get('level', 1)
     description = data.get('description')
-    cookies = storage.get('cookies', [])
-    origins = storage.get('origins')
-
-    if not cookies and not origins:
-        return {'error': 'No cookies or local storage to import'}, 400
 
     # Create new cookiejar
     if not cookiejar_uuid:
@@ -1223,19 +1298,9 @@ def api_import_lacus_cookiejar(user_org, user_id, data, cookiejar_uuid=None):
         cookiejar = Cookiejar(cookiejar_uuid)
         if not cookiejar.exists():
             return {'error': 'unknown cookiejar uuid'}, 404
-        cookiejar.delete_local_storage()
-    for cookie in cookies:
-        name = cookie.get('name')
-        value = cookie.get('value')
-        domain = cookie.get('domain')
-        path = cookie.get('path')
-        expires = cookie.get('expires')
-        httponly = cookie.get('httpOnly')
-        secure = cookie.get('secure')
-        samesite = cookie.get('sameSite')
-        if name and value:
-            cookiejar.add_cookie(name, value, domain=domain, httponly=httponly, path=path, secure=secure, expires=expires, samesite=samesite)
-    cookiejar.set_local_storage(storage)
+    res = _import_storage_in_cookiejar(cookiejar, storage)
+    if res:
+        return res
 
     return {'cookiejar_uuid': cookiejar_uuid}, 200
 

var/www/blueprints/crawler_splash.py

@@ -1027,6 +1027,50 @@ def crawler_cookiejar_local_storage_delete():
     return redirect(url_for('crawler_splash.crawler_cookiejar_show', uuid=cookiejar_uuid))
 
 
+@crawler_splash.route('/crawler/cookiejar/json/export', methods=['GET'])
+@login_required
+@login_admin
+def crawler_cookiejar_json_export():
+    user_org = current_user.get_org()
+    user_id = current_user.get_user_id()
+    user_role = current_user.get_role()
+    cookiejar_uuid = request.args.get('uuid')
+
+    res = crawlers.api_export_cookiejar_json(user_org, user_id, user_role, cookiejar_uuid)
+    if res[1] != 200:
+        return create_json_response(res[0], res[1])
+    response = Response(json.dumps(res[0], indent=2, sort_keys=True), mimetype='application/json')
+    response.headers['Content-Disposition'] = f'attachment; filename=cookiejar-{cookiejar_uuid}.json'
+    return response
+
+
+@crawler_splash.route('/crawler/cookiejar/json/import', methods=['POST'])
+@login_required
+@login_admin
+def crawler_cookiejar_json_import():
+    user_org = current_user.get_org()
+    user_id = current_user.get_user_id()
+    user_role = current_user.get_role()
+    cookiejar_uuid = request.form.get('uuid')
+
+    if 'file' not in request.files:
+        return create_json_response({'error': 'cookiejar JSON file not set'}, 400)
+
+    file = request.files['file']
+    try:
+        data = json.loads(file.read().decode())
+    except json.decoder.JSONDecodeError:
+        return create_json_response({'error': 'invalid cookiejar JSON'}, 400)
+
+    if cookiejar_uuid:
+        res = crawlers.api_import_cookiejar_json(user_org, user_id, user_role, cookiejar_uuid, data)
+    else:
+        res = crawlers.api_create_cookiejar_from_json(user_org, user_id, data)
+    if res[1] != 200:
+        return create_json_response(res[0], res[1])
+    return redirect(url_for('crawler_splash.crawler_cookiejar_show', uuid=res[0]['cookiejar_uuid']))
+
+
 @crawler_splash.route('/crawler/cookiejar/delete', methods=['GET'])
 @login_required
 @login_user_no_api

var/www/templates/crawler/crawler_splash/all_cookiejar.html

@@ -67,6 +67,16 @@ <h5 class="card-title"><i class="fas fa-cookie-bite"></i> Global Cookiejar</h5>
           Create Cookiejar
         </a>
 
+        {% if current_user.is_admin() %}
+          <form class="d-inline-block my-4" action="{{ url_for('crawler_splash.crawler_cookiejar_json_import') }}" method="post" enctype="multipart/form-data">
+            <label class="btn btn-warning mb-0">
+              <i class="fas fa-file-import"></i>
+              Import Cookiejar JSON
+              <input type="file" name="file" accept="application/json,.json" onchange="this.form.submit();" hidden>
+            </label>
+          </form>
+        {% endif %}
+
       </div>
 		</div>
 	</div>

var/www/templates/crawler/crawler_splash/show_cookiejar.html

@@ -49,6 +49,19 @@ <h5 class="card-title"><i class="fas fa-cookie-bite"></i> Edit Cookiejar</h5>
 							Edit Description <i class="fas fa-pencil-alt"></i>
 						</button>
 
+                        {% if current_user.is_admin() %}
+                            <a class="btn btn-secondary" href="{{ url_for('crawler_splash.crawler_cookiejar_json_export') }}?uuid={{cookiejar_metadata['uuid']}}">
+                                Export JSON <i class="fas fa-file-export"></i>
+                            </a>
+                            <form class="d-inline-block" action="{{ url_for('crawler_splash.crawler_cookiejar_json_import') }}" method="post" enctype="multipart/form-data">
+                                <input type="hidden" name="uuid" value="{{cookiejar_metadata['uuid']}}">
+                                <label class="btn btn-warning mb-0">
+                                    Import JSON <i class="fas fa-file-import"></i>
+                                    <input type="file" name="file" accept="application/json,.json" onchange="this.form.submit();" hidden>
+                                </label>
+                            </form>
+                        {% endif %}
+
 						<span class="mt-1" id="description-edit-block">
 							<div class="input-group">
 								<input class="form-control" type="text" id="input-description" value="{{cookiejar_metadata['description']}}">