Commments

plugins/webui/interface/controllers/admin.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from ...exceptions import *
 from .base import get_response
 
@@ -8,15 +9,30 @@ from ...client import WebUiClient
 import leapi_dyncode as dyncode
 import warnings
 
+##@brief These functions are called by the rules defined in ../urls.py
+## To administrate the instance of the editorial model
+
+##@brief Controller's function to redirect on the home page of the admin 
+# @param request : the request (get or post)
+# @note the response is given in a html page called in get_response_function
 def index_admin(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive 
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     return get_response('admin/admin.html')
 
+##@brief Controller's function to update an object of the editorial model 
+# @param request : the request (get or post)
+# @note the response is given in a html page (in templates/admin) called in get_response_function
 def admin_update(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     msg=''
+    
+    # If the form has been submitted
     if request.method == 'POST':
         error = None
         datas = list()
@@ -29,14 +45,18 @@ def admin_update(request):
             classname = None
         if classname is None or target_leo.is_abstract():
             raise HttpException(400)
-        fieldnames = target_leo.fieldnames()
 
         uid_field = target_leo.uid_fieldname()[0]
         fields = dict()
 
         for in_put, in_value in request.form.items():
+            # The classname is handled by the datasource, we are not allowed to modify it
+            # uid is not a fieldname
+            # both are hidden in the form, to identify the object here
             if in_put != 'classname' and  in_put != 'uid':
                 dhl = target_leo.data_handler(in_put[12:])
+                # Here, in case of a Reference we transform the str 
+                # given by the form in a iterable (a list) 
                 if dhl.is_reference() and in_value != '':
                     in_value.replace(" ","")
                     in_value=in_value.split(',')
@@ -44,9 +64,11 @@ def admin_update(request):
                 if in_value != '':
                     fields[in_put[12:]] = in_value
 
+        # We retrieve the object to update
         filter_q = '%s = %s' % (uid_field, uid)
         obj = (target_leo.get((filter_q)))[0]
-
+        
+        # and update it
         inserted = obj.update(fields)
         
         if inserted==1:
@@ -55,7 +77,9 @@ def admin_update(request):
             msg = 'Oops something wrong happened...object not saved'
         return get_response('admin/admin_edit.html', target=target_leo, uidfield = uid_field, lodel_id = uid, msg = msg)
 
+    # Display of the form with the object's values to be updated
     if 'classname' in request.GET:
+        # We need the class of the object to update
         classname = request.GET['classname']
         if len(classname) > 1:
             raise HttpException(400)
@@ -67,13 +91,16 @@ def admin_update(request):
             raise HttpException(400)
         logger.warning('Composed uids broken here')
         uid_field = target_leo.uid_fieldname()[0]
-
+    
+    # We need the uid of the object
     test_valid = 'lodel_id' in request.GET \
         and len(request.GET['lodel_id']) == 1
 
     if test_valid:
         try:
             dh = target_leo.field(uid_field)
+            # we cast the uid extrated form the request to the adequate type
+            # given by the datahandler of the uidfield's datahandler
             lodel_id = dh.cast_type(request.GET['lodel_id'][0])
         except (ValueError, TypeError):
             test_valid = False
@@ -81,6 +108,8 @@ def admin_update(request):
     if not test_valid:
         raise HttpException(400)
     else:
+        # Check if the object actually exists
+        # We get it from the database
         query_filters = list()
         query_filters.append((uid_field,'=',lodel_id))
         obj = target_leo.get(query_filters)
@@ -88,11 +117,16 @@ def admin_update(request):
             raise HttpException(404)
     return get_response('admin/admin_edit.html', target=target_leo, lodel_id =lodel_id)
 
+##@brief Controller's function to create an object of the editorial model 
+# @param request : the request (get or post)
+# @note the response is given in a html page (in templates/admin) called in get_response_function
 def admin_create(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     classname = None
-
+     # If the form has been submitted
     if request.method == 'POST':
         error = None
         datas = list()
@@ -107,18 +141,25 @@ def admin_create(request):
         fields = dict()
 
         for in_put, in_value in request.form.items():
+            # The classname is handled by the datasource, we are not allowed to modify it
+            # uid is not a fieldname
+            # both are hidden in the form, to identify the object here
             if in_put != 'classname' and in_value != '':
                 fields[in_put[12:]] = in_value
-
+        
+        # Insertion in the database of the values corresponding to a new object
         new_uid = target_leo.insert(fields)
         
+        # reurn to the form with a confirmation or error message
         if not new_uid is None:
             msg = 'Successfull creation';
         else:
             msg = 'Oops something wrong happened...object not saved'
         return get_response('admin/admin_create.html', target=target_leo, msg = msg)
     
+    # Display of an empty form
     if 'classname' in request.GET:
+        # We need the class to create an object in
         classname = request.GET['classname']
         if len(classname) > 1:
             raise HttpException(400)
@@ -127,19 +168,23 @@ def admin_create(request):
             target_leo = dyncode.Object.name2class(classname)
         except LeApiError:
             classname = None
-    msg = None
-    if 'msg' in request.GET:
-        msg = request.GET['msg']
+
     if classname is None or target_leo.is_abstract():
         raise HttpException(400)
     return get_response('admin/admin_create.html', target=target_leo)
 
+##@brief Controller's function to delete an object of the editorial model 
+# @param request : the request (get)
+# @note the response is given in a html page (in templates/admin) called in get_response_function
 def admin_delete(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     classname = None
 
     if 'classname' in request.GET:
+        # We need the class to delete an object in
         classname = request.GET['classname']
         if len(classname) > 1:
             raise HttpException(400)
@@ -151,13 +196,16 @@ def admin_delete(request):
             raise HttpException(400)
         logger.warning('Composed uids broken here')
         uid_field = target_leo.uid_fieldname()[0]
-
+        
+    # We also need the uid of the object to delete
     test_valid = 'lodel_id' in request.GET \
         and len(request.GET['lodel_id']) == 1
 
     if test_valid:
         try:
             dh = target_leo.field(uid_field)
+            # we cast the uid extrated form the request to the adequate type
+            # given by the datahandler of the uidfield's datahandler
             lodel_id = dh.cast_type(request.GET['lodel_id'][0])
         except (ValueError, TypeError):
             test_valid = False
@@ -179,23 +227,32 @@ def admin_delete(request):
         
         
 def admin_classes(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     return get_response('admin/list_classes_admin.html', my_classes = dyncode.dynclasses)
 
 def create_object(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     return get_response('admin/list_classes_create.html', my_classes = dyncode.dynclasses)
 
 def delete_object(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     return get_response('admin/list_classes_delete.html', my_classes = dyncode.dynclasses)
     
 def admin_class(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
+    # We need the class we'll list to select the object to edit
     if 'classname' in request.GET:
         classname = request.GET['classname']
         if len(classname) > 1:
@@ -210,8 +267,11 @@ def admin_class(request):
     return get_response('admin/show_class_admin.html', target=target_leo)
 
 def delete_in_class(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
+    # We need the class we'll list to select the object to delete
     if 'classname' in request.GET:
         classname = request.GET['classname']
         if len(classname) > 1:
@@ -226,6 +286,8 @@ def delete_in_class(request):
     return get_response('admin/show_class_delete.html', target=target_leo)
 
 def admin(request):
+    # We have to be identified to admin the instance
+    # temporary, the acl will be more restrictive
     if WebUiClient.is_anonymous():
         return get_response('users/signin.html')
     return get_response('admin/admin.html')

plugins/webui/interface/controllers/listing.py

@@ -4,6 +4,12 @@ from ...exceptions import *
 from lodel import logger
 import leapi_dyncode as dyncode
 
+##@brief These functions are called by the rules defined in ../urls.py
+## To browse the editorial model
+
+##@brief Controller's function to list all types (classes) of the editorial model
+# @param request : the request (get or post)
+# @note the response is given in a html page called in get_response_function
 def list_classes(request):
     if 'allclasses' in request.GET:
         allclasses = request.GET['allclasses']
@@ -11,6 +17,9 @@ def list_classes(request):
         allclasses = 1
     return get_response('listing/list_classes.html', my_classes=dyncode.dynclasses, allclasses = allclasses)
 
+##@brief Controller's function to display a type (class) of the editorial model
+# @param request : the request (get or post)
+# @note the response is given in a html page called in get_response_function
 def show_class(request):
     if 'classname' in request.GET:
         classname = request.GET['classname']
@@ -25,6 +34,9 @@ def show_class(request):
         raise HttpException(400)
     return get_response('listing/show_class.html', classname=classname)
 
+##@brief Controller's function to display an instance or a certain type
+# @param request : the request (get or post)
+# @note the response is given in a html page called in get_response_function
 def show_object(request):
     if 'classname' in request.GET:
         classname = request.GET['classname']

plugins/webui/interface/controllers/users.py

@@ -6,10 +6,19 @@ from ...client import WebUiClient as WebUiClient
 from lodel import logger
 import leapi_dyncode as dyncode
 
+##@brief These functions are called by the rules defined in ../urls.py
+## Their goal is to handle the user authentication
+
+##@brief Controller's function to login a user, the corresponding form is in interface/users
+# @param request : the request (get or post)
+# @note the response is given in a html page called in get_response_function
 def signin(request):
     msg=''
+    # The form send the login and password, we can authenticate the user
     if request.method == 'POST':
-        WebUiClient.authenticate(request.form['inputLogin'], request.form['inputPassword'])
+        login = request.form['inputLogin']
+        WebUiClient.authenticate(login, request.form['inputPassword'])
+        # We get the informations about the user
         uid=WebUiClient['__auth_user_infos']['uid']
         leoclass=WebUiClient['__auth_user_infos']['leoclass']
         query_filter=list()
@@ -18,7 +27,10 @@ def signin(request):
         return get_response('users/welcome.html', username = user[0].data('login'))
     else:
         return get_response('users/signin.html')
-
+    
+##@brief Controller's function to logout a user
+# @param request : the request (get or post)
+# @note the response is given in the login html page 
 def signout(request):
     WebUiClient.destroy()
     return get_response('users/signin.html')

plugins/webui/templates/users/signin.html

@@ -11,7 +11,7 @@
   <div class="form-group">
     <label for="inputLogin" class="col-sm-2 control-label">Login</label>
     <div class="col-xs-4">
-      <input type="text" class="form-control" id="inputLogin" name="inputLogin" placeholder="Login">
+      <input type="text" class="form-control" id="inputLogin" name="inputLogin" placeholder="Login" required>
     </div>
   </div>
   <div class="form-group">