module.py

Go to the documentation of this file.

#
# Collective Mind
#
# See cM LICENSE.txt for licensing details.
# See cM Copyright.txt for copyright details.
#
# Developer(s): (C) Grigori Fursin, started on 2011.09
#

# Should always be here
ini={}
cm_kernel=None

# Local settings
import string
import os
import hashlib
import base64
import getpass

# ============================================================================
def init(i):
    return {'cm_return':0}

# ============================================================================
def add_data(i):

    """
    Add user (and public person profile)

    Input:  {
              cm_username             - username (UOA)
              cm_user_password        - user password
              cm_user_password_repeat - repeat user password for checking
              name                    - user real name (will be used as alias)

              (cm_array)              - Note, that if cm_array is present, 
                                        all above parameters should be inside it

              (cm_repo_uoa)           - repo UOA where to create user entry
            }

    Output: {
              cm_return  - return code >0 if error
              cm_path    - path to created data entry
              ...        - other paramaters from core add_data function
            }
    """

    # Check if default repo to create user
    if i.get('cm_repo_uoa','')=='':
       if cm_kernel.ini['dcfg'].get('cm_default_repo_for_user', '')!='':
          i['cm_repo_uoa']=cm_kernel.ini['dcfg'].get('cm_default_repo_for_user')

    # If web access, move to 'core' module
    if i.get('cm_console','')=='web':
       #Set owner
       if i.get('#form4##cm_access_control#read_groups','')=='':  i['#form4##cm_access_control#read_groups']='owner'
       if i.get('#form4##cm_access_control#write_groups','')=='': i['#form4##cm_access_control#write_groups']='owner'

       i['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
       i['cm_action']='add'
       return cm_kernel.access(i)

    # Check if cm_array or CMD
    if 'cm_array' in i: ir=i['cm_array'] 
    else: ir=i

    # Second, process request
    # Get unique username to make UOA
    username=''
    if ir.get('cm_username', '')=='':
       ir['cm_username']=raw_input('Enter unique username: ')
    if ir.get('cm_username', '')=='':
       return {'cm_return':1, 'cm_error':'unique username is not set'}
    username=ir['cm_username']
    del(ir['cm_username'])
    username=username.strip()

    # Get passwords
    pass1=ir.get('cm_user_password', '')
    if pass1=='': 
       pass1=getpass.getpass('Enter password: ')
       ir['cm_user_password']=pass1
    if pass1=='': 
       return {'cm_return':1, 'cm_error':'password is not set'}
    del(ir['cm_user_password'])
    pass1=pass1.strip()

    pass2=ir.get('cm_user_password_repeat', '')
    if pass2=='': 
       pass2=getpass.getpass('Repeat password: ')
       ir['cm_user_password_repeat']=pass2
    if pass2=='': return {'cm_return':1, 'cm_error':'second password is not set'}
    del(ir['cm_user_password_repeat'])
    pass2=pass2.strip()
    if pass1!=pass2:
       return {'cm_return':1, 'cm_error':'passwords do not match'}

    # First hash (compatible with htpasswd)
    rs=cm_kernel.convert_str_to_sha1({'cm_string':pass1})
    if rs['cm_return']>0: return rs
    hash1=rs['cm_string_sha1_base64']

    # Second hash (compatible with htpasswd)
    rs=cm_kernel.convert_str_to_sha1({'cm_string':hash1})
    if rs['cm_return']>0: return rs
    hash2=rs['cm_string_sha1_base64']

    ir['cm_user_password2']=hash2

    # Go to common core function to create entry (user) - private profile
    if cm_kernel.ini.get('web','')=='yes' and i.get('cm_console','')!='json': cm_kernel.print_for_con('<H2>Private profile created!</H2>')

    ii={};ii.update(i)
    ii['cm_admin']='yes'
    ii['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
    ii['cm_module_uoa']=ini['cm_module_uid']
    ii['cm_data_uoa']=username
    ii['cm_console']=''
    if cm_kernel.ini.get('cm_console','')!='web': ii['cm_console']=i.get('cm_console','')
    if cm_kernel.ini.get('web','')=='yes' and i.get('cm_console','')!='json': ii['cm_report_in_html']='yes'

    ii['cm_access_control']=ini['cfg']["cm_default_private_access_control"]

    if 'name' in ir: ir['cm_display_as_alias']=ir['name']
    ii['cm_array']=ir

    ru=cm_kernel.access(ii)
    if ru['cm_return']>0: return ru

    # Save to local htpasswd
    p=ru['cm_path']
    f=file(os.path.join(p, '.htpasswd'), 'w')
    f.write(username+':{SHA}'+hash1+'\n')
    f.close()

    # Go to common core function to create entry (person) - public profile
    if cm_kernel.ini.get('web')=='yes' and i.get('cm_console','')!='json': 
       cm_kernel.print_for_con('<HR class="cm-hr">')
       cm_kernel.print_for_con('<H2>Public profile created!</H2>')

    ii={};ii.update(i)

    ii['cm_admin']='yes'
    ii['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
    ii['cm_module_uoa']=ini['cfg']['cm_modules']['cm-person']
    ii['cm_data_uoa']=username
    ii['cm_data_uid']=ru['cm_uid']
    ii['cm_console']=''
    if cm_kernel.ini.get('cm_console','')!='web': ii['cm_console']=i.get('cm_console','')
    if cm_kernel.ini.get('web','')=='yes' and i.get('cm_console','')!='json': ii['cm_report_in_html']='yes'

    if 'cm_user_password2' in ir: del(ir['cm_user_password2'])
    if 'cm_user_groups' in ir: del(ir['cm_user_groups'])
    if 'cm_default_web_uoa' in ir: del(ir['cm_default_web_uoa'])

    ii['cm_access_control']=ini['cfg']["cm_default_public_access_control"]

    ii['cm_array']=ir

    r=cm_kernel.access(ii)
    if r['cm_return']>0: return r

    # We need it here since this function overloads original 'core' add_data function
    ru['cm_skip_report']='yes'

    return ru

# ============================================================================
def update_data(i):

    """
    Input:  {
            }

    Output: {
            }
    """

    # If web access, move to 'core' module
    if i.get('cm_console','')=='web':
       i['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
       i['cm_action']='update'
       return cm_kernel.access(i)

    # Check if cm_array or CMD
    if 'cm_array' in i: ir=i['cm_array'] 
    else: ir=i

    # Load data to get path
    ii={}
    ii['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
    ii['cm_action']='load'
    if 'cm_module_uoa' in i: ii['cm_module_uoa']=i['cm_module_uoa']
    if 'cm_data_uoa' in i: ii['cm_data_uoa']=i['cm_data_uoa']
    if i.get('cm_repo_uoa','')=='':
       if cm_kernel.ini['dcfg'].get('cm_default_repo_for_add','')!='':
          ii['cm_repo_uoa']=cm_kernel.ini['dcfg']['cm_default_repo_for_add']
    else:
       ii['cm_repo_uoa']=i['cm_repo_uoa']
    rx=cm_kernel.access(ii)
    if rx['cm_return']>0: return rx

    # Get passwords
    pass1=ir.get('cm_user_password', '')
    if 'cm_user_password' in ir: del(ir['cm_user_password'])
    pass2=ir.get('cm_user_password_repeat', '')
    if 'cm_user_password_repeat' in ir: del(ir['cm_user_password_repeat'])
 
    if pass1!=pass2:
       return {'cm_return':1, 'cm_error':'passwords do not match'}

    if pass1=='':
       # Do not update password
       if 'cm_user_password2' in ir: del(ir['cm_user_password2'])
    else:
       # First hash (compatible with htpasswd)
       rs=cm_kernel.convert_str_to_sha1({'cm_string':pass1})
       if rs['cm_return']>0: return rs
       hash1=rs['cm_string_sha1_base64']

       # Second hash (compatible with htpasswd)
       rs=cm_kernel.convert_str_to_sha1({'cm_string':hash1})
       if rs['cm_return']>0: return rs
       hash2=rs['cm_string_sha1_base64']

       ir['cm_user_password2']=hash2

       # Save to local htpasswd
       p=rx['cm_path']
       f=file(os.path.join(p, '.htpasswd'), 'w')
       f.write(rx['cm_uoa']+':{SHA}'+hash1+'\n')
       f.close()

    ii={};ii.update(i)
    ii['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
    ii['cm_console']=''
    if cm_kernel.ini.get('cm_console','')!='web': ii['cm_console']=i.get('cm_console','')
    if cm_kernel.ini.get('web','')=='yes': ii['cm_report_in_html']='yes'

    if 'name' in ir: ir['cm_display_as_alias']=ir['name']

    ii['cm_array']=ir

    ru=cm_kernel.access(ii)
    if ru['cm_return']>0: return ru

    # Check if public profile exists and if not, create it
    ii['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
    ii['cm_action']='load'
    ii['cm_module_uoa']=ini['cfg']['cm_modules']['cm-person']
    ii['cm_data_uoa']=ru['cm_uoa']
    ii['cm_data_uid']=ru['cm_uid']
    r=cm_kernel.access(ii)
    if r['cm_return']>0: 
       # Check if default repo to create user
       if cm_kernel.ini['dcfg'].get('cm_default_repo_for_user', '')!='':
          i['cm_repo_uoa']=cm_kernel.ini['dcfg'].get('cm_default_repo_for_user')

       # Go to common core function to create entry (person) - public profile
       if cm_kernel.ini.get('web')=='yes' and i.get('cm_console','')!='json': 
          cm_kernel.print_for_con('<HR class="cm-hr">')
          cm_kernel.print_for_con('<H2>Adding public profile:</H2>')

       ii={};ii.update(i)

       ii['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
       ii['cm_module_uoa']=ini['cfg']['cm_modules']['cm-person']
       ii['cm_data_uoa']=ru['cm_uoa']
       ii['cm_data_uid']=ru['cm_uid']
       ii['cm_console']=''
       if cm_kernel.ini.get('cm_console','')!='web': ii['cm_console']=i.get('cm_console','')
       if cm_kernel.ini.get('web','')=='yes': ii['cm_report_in_html']='yes'

       if 'cm_user_password2' in ir: del(ir['cm_user_password2'])
       if 'cm_user_groups' in ir: del(ir['cm_user_groups'])
       if 'cm_default_web_uoa' in ir: del(ir['cm_default_web_uoa'])

       ii['cm_access_control']=ini['cfg']["cm_default_public_access_control"]

       ii['cm_array']=ir

       r=cm_kernel.access(ii)
       if r['cm_return']>0: return r

    # We need it here since this function overloads original 'core' update_data function
    ru['cm_skip_report']='yes'

    return ru