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 shutil
import json

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

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

    """
    Add module

    Input:  {
            }

    Output: {
              cm_return  - return code >0 if error
              cm_path    - path to created data entry
            }
    """

    if 'cm_file_in' in i:
       p1=os.path.join(ini['path'], i['cm_file_in'])
       if not os.path.isfile(p1):
          return {'cm_return':1, 'cm_error':'can\'t find file '+p1}

    # 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']='add'
       return cm_kernel.access(i)

    # Go to common core function
    i['cm_run_module_uoa']=ini['cfg']['cm_modules']['cm-core']
    if cm_kernel.ini.get('cm_console','')!='web':  i['cm_console']=i.get('cm_console','')
    else:                                          i['cm_console']=''
    if cm_kernel.ini.get('web','')=='yes': i['cm_report_in_html']='yes'
    r=cm_kernel.access(i)
    if r['cm_return']>0: return r

    if 'cm_file_out' in i:
       p2=os.path.join(r['cm_path'], i['cm_file_out'])
       if os.path.isfile(p2):
          return {'cm_return':1, 'cm_error':'file already exists '+p2}
       else:
          shutil.copyfile(p1,p2)

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

    return r

# ============================================================================
def visualize_connections(i):
    """
    Detect parameters in web forms 

    Input:  {
              cm_show_only_graph - if 'yes', show only graph and skip all the rest
              cm_width           - graph width
              cm_height          - graph height
            }

    Output: {
              cm_return  - return code >0 if error
              cm_array   - parsed array with keys
              cm_actions - parsed array with commands
            }
    """

    # Web style
    if 'cfg' in cm_kernel.ini['web_style']: web=cm_kernel.ini['web_style']['cfg']
    else:
       return {'cm_return':1, 'cm_error':'web style is not defined'}

    # Detecting/restoring data from forms
    a1={}

    r=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-web'],
                        'cm_action':'detect_form_params',
                        'cm_array':i, 
                        'cm_prefix':'#form1'})
    if r['cm_return']>0: return r
    cm_form_array1=r['cm_array']
    cm_form_commands1=r['cm_commands']

    # Get data description for this action
    r=cm_kernel.get_data_description({'cm_module_uoa':ini['cm_module_uoa'], 
                                      'cm_which_action':i['cm_action']})
    if r['cm_return']>0: return r
    cm_data_desc=r['cm_data_desc']
    cm_params_default=r['cm_params_default']

    # Check default
    if len(cm_form_array1)==0:
       a1=cm_params_default
    else:
       r=cm_kernel.restore_flattened_array({'cm_array':cm_form_array1, 
                                            'cm_replace_in_keys':{'^35^':'#', '^64^':'@'}})
       if r['cm_return']>0: return r
       a1=r['cm_array']

    # Set default
    width="900"
    if 'cm_width' in a1: width=a1['cm_width']
    elif 'cm_width' in i: width=i['cm_width']
#    a1['cm_width']=width

    height="600"
    if 'cm_height' in a1: height=a1['cm_height']
    elif 'cm_height' in i: height=i['cm_height']
#    a1['cm_height']=height

    # If there is data in form, means that refresh
    forms_exists='yes'
    if len(cm_form_array1)==0:forms_exists='no'

    # Get list of modules
    ls=[]
    ls1=[]
    pm=a1.get('prune_module_uoa','')

    r=cm_kernel.access({'cm_run_module_uoa':ini['cm_module_uid'],
                        'cm_action':'list'})
    if r['cm_return']>0: return r
    ls=r['cm_mixed']

    if pm=='':
       ls1=ls
    else:
       r=cm_kernel.access({'cm_run_module_uoa':ini['cm_module_uid'],
                           'cm_action':'load',
                           'cm_data_uoa':pm})
       if r['cm_return']>0: return r
       ls1.append(r)

    # Nodes
    a={'nodes':[], 'links':[]}

    nodes={}
    inodes=0

    # Links
    for l in ls1:
        x=l['cm_uoa'];  xu=l['cm_uid'];  xa=l['cm_alias'];  xd=l['cm_display_html']
   
        # Load module
        rx=cm_kernel.access({'cm_run_module_uoa':ini['cm_module_uid'],
                            'cm_action':'load',
                            'cm_data_uoa':xu})
        if rx['cm_return']>0 and ry['cm_return']!=16 and ry['cm_return']!=32: return rx
        if rx['cm_return']==0:
           d=rx['cm_data_obj']

           m=[]

           if 'cm_modules' in d['cfg']: 
              for q in d['cfg']['cm_modules']:
                  m.append(d['cfg']['cm_modules'][q])

           if 'cm_data_description' in d['cfg']:
              for q in d['cfg']['cm_data_description']:
                  dx=d['cfg']['cm_data_description'][q]
                  if dx.get('type','')=='uoa':
                     if dx.get('cm_module_uoa','')!='': 
                        m.append(dx['cm_module_uoa'])

           for q in m:
               # Load sub-module
               ry=cm_kernel.access({'cm_run_module_uoa':ini['cm_module_uid'],
                                   'cm_action':'load',
                                   'cm_data_uoa':q})
               if ry['cm_return']>0 and ry['cm_return']!=16 and ry['cm_return']!=32: return ry
               if ry['cm_return']==0:
                  y=ry['cm_uoa'];  yu=ry['cm_uid'];  ya=ry['cm_alias'];  yd=ry['cm_display_html']

                  if xu!=yu:
                     if xu not in nodes:
                        a['nodes'].append({"name":xd, "group":xu, "uid":xu})
                        nodes[xu]=inodes
                        inodes+=1 
                     nxu=nodes[xu]

                     if yu not in nodes:
                        a['nodes'].append({"name":yd, "group":yu, "uid":yu})
                        nodes[yu]=inodes
                        inodes+=1 
                     nyu=nodes[yu]

                     a['links'].append({"source":nxu, "target": nyu, "type":"arrow"})

    # Load D3 data
    rx=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-code'],
                         'cm_action':'load',
                         'cm_data_uoa':ini['cfg']['cm_web_d3_uoa']})
    if rx['cm_return']>0: return rx

    web_d3=rx['cm_data_obj']['cfg']

    link_d3=web['http_prefix']+'cm_web_action=show&cid='+ini['cfg']['cm_modules']['cm-code']+':'+ini['cfg']['cm_web_d3_uoa']+'&cm_web_filename=d3.v2.js'

    # Prepare visualization
    if i.get('cm_show_only_graph','')!='yes':
       cm_kernel.print_for_con('<span class="cm-title"><center>Visualize connections between modules</center></span>')

    cm_kernel.print_for_con('<script type="text/javascript" src="'+link_d3+'"></script>')

    cm_kernel.print_for_web(web['table_init']+'<tr><td>')
    cm_kernel.print_for_con('<div id="chart"></div>')
    if i.get('cm_show_only_graph','')!='yes':
       cm_kernel.print_for_con('<center><a href="#" id="download"><br>Download svg (experimental)</a></center>')
    cm_kernel.print_for_web('</td></tr></table>')

    cm_kernel.print_for_con(web_d3['d3_force_css'])

    cm_kernel.print_for_con('<script type="text/javascript">')
    cm_kernel.print_for_con('var nodes='+json.dumps(a['nodes'])+';')
    cm_kernel.print_for_con('var links='+json.dumps(a['links'])+';')

#    sou=web['http_prefix']+'cm_menu='+web['cm_menu_browse']+'&cm_subaction_view&browse_cid='+ini['cm_module_uoa']+':'
    sou=web['http_prefix']+'view_cid='+ini['cm_module_uoa']+':'

    h=web_d3['d3_force_html'].replace(cm_kernel.convert_str_to_special('url'), sou)
    h=h.replace(cm_kernel.convert_str_to_special('cm_width'), width)
    h=h.replace(cm_kernel.convert_str_to_special('cm_height'), height)
    cm_kernel.print_for_con(h)

    cm_kernel.print_for_con('</script>')
 
    # Start form
    if i.get('cm_show_only_graph','')!='yes':
       # Customize form
       cm_kernel.print_for_con('<br><small><b>Customize</b></small>')

       cm_kernel.print_for_web('<FORM ACTION="" name="add_edit" METHOD="POST" enctype="multipart/form-data" accept-charset="utf-8">' )

       ii={'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-web'],
           'cm_action':'visualize_data',
           'cm_array':a1,
           'cm_data_desc':cm_data_desc,
           'cm_form_commands':cm_form_commands1,
           'cm_separator':'#',
           'cm_separator_form':'#form1#',
           'cm_forms_exists':forms_exists,
           'cm_support_raw_edit':'yes',
           'cm_mode':'add'}
       if 'cm_raw_edit' in i: ii['cm_raw_edit']=i['cm_raw_edit']
       if 'cm_back_json' in i: ii['cm_back_json']=i['cm_back_json']
       r=cm_kernel.access(ii)
       if r['cm_return']>0: return r
       cm_kernel.print_for_web(r['cm_string'])

       cm_kernel.print_for_con('<input type="submit" class="cm-button" value="Refresh">')

       cm_kernel.print_for_con('</FORM>')

       cm_kernel.print_for_con('<HR class="cm-hr">')

    return {'cm_return':0}