user.py

Go to the documentation of this file.

#!/usr/bin/python
# -*- coding: utf-8 -*- 
 
from pafera.db import *
 
import pafera.modelbase
 
from pafera.validators import *
 
# Flag constants for the user object
USER_MUST_CHANGE_PASSWORD  = 0x01
USER_DISABLED              = 0x02
USER_NEED_APPROVAL         = 0x04
USER_REJECTED              = 0x08
USER_CAN_MANAGE_SELF       = 0x10
 
# Constants for user-user relationships
# 
# For example, to get all friends, you can use
# friends = g.db.Linked(user, system_user, USER_FRIEND)
#
# friends must be agreed upon by both users in order to take effect.
#
# acquaintances are added whenever two users send messages to one
# another. 
#
USER_FRIEND         = 1
USER_ACQUAINTANCE   = 2
USER_FOLLOW         = 3
USER_BLOCKED        = 4
 
# *********************************************************************
class system_user(pafera.modelbase.ModelBase):
  """User accounts for the system. Handles logins, uploads, storage 
  quotas, access tokens, and the such.
  
  Pafera adds a place field to the traditional username/password
  combination, both for added security and to allow different places
  to use the same phone number for their own accounts. It's the 
  unique combination of (phonenumber, place, password) that
  identifies a particular user.
  
  Note that displayname is a translation field, meaning that that 
  a user can have their own names in different languages. 
  
  expiredate is when the user account will expire. Set it far into
  the future for your own administrator account.
  
  canmanage and managedby are used for managed accounts such as 
  students being managed by a teacher. Managed accounts cannot
  change anything besides change their own password. 
  
  accesstokens are used by the system to allow APIs to assume the 
  identity of a user. The APIs used must be explicitly specified for 
  the token to work. The token format is a dict such as
  {
    "token":      tokenvalue,
    "expiredate": timestamp,
    "apilist":    [
                    '/system/fileapi:search',
                    '/system/fileapi:load',
                    '/system/fileapi:save'
                  ]
  }
  """
  
  _dbfields     = {
    'rid':            ('INTEGER PRIMARY KEY', 'NOT NULL',),
    'phonenumber':    ('TEXT', 'NOT NULL', BlankValidator()),
    'place':          ('TEXT', 'NOT NULL', BlankValidator()),
    'password':       ('PASSWORD', 'NOT NULL', BlankValidator()),
    'email':          ('TEXT', "NOT NULL DEFAULT ''",),
    'displayname':    ('TRANSLATION', 'NOT NULL', BlankValidator()),
    'settings':       ('DICT', "NOT NULL DEFAULT ''",),
    'expiredate':     ('DATETIME', "NOT NULL DEFAULT 0",),
    'storageused':    ('BIGINT', "NOT NULL DEFAULT 0",),
    'storagequota':   ('BIGINT', "NOT NULL DEFAULT 134217728",),
    'numcanmmanage':  ('INT', "NOT NULL DEFAULT 0",),
    'canmanage':      ('NEWLINELIST', "NOT NULL DEFAULT ''",),
    'managedby':      ('NEWLINELIST', "NOT NULL DEFAULT ''",),
    'accesstokens':   ('DICT', "NOT NULL DEFAULT ''",),
    'flags':          ('INT', 'NOT NULL DEFAULT 0',),
  }
  _dbindexes  = (
    ('unique', ('phonenumber', 'place')),
  )
  _dblinks    = ['system_group', 'system_user']
  _dbdisplay  = ['place', 'displayname', 'phonenumber']
  _dbflags    = 0
 
  _managejs = """
G.displayfuncs['system_user']  = function(type, fields, item, ls, modellinks, data)
{
  let modelid     = G.modelids['system_user'];
  let modelinfo   = G.modelfields['system_user'];
  let idcode      = ToShortCode(item['rid']);
  
  if (type == 'card')
  {    
    ls.push(`<div class="blueg Center">${item['rid']} (${idcode})</div>
      <div>
        ${P.HeadShotImg(idcode, 'Square600')}<br>
      </div>`
    );
  } else
  {
    ls.push(`<th class="Center">
      ${P.HeadShotImg(idcode, 'Square600')}<br>
      ${item['rid']} (${idcode})
    </th>`);
  }
    
  for (let j = 1, m = fields.length; j < m; j++)
  {
    let k = fields[j];
    
    let value = item[k];
    let valuetype = modelinfo[k][0];
    
    if (type == 'card')
    {    
      if (valuetype == 'JSON')
      {
        ls.push('<pre>' + JSON.stringify(value, null, 2) + '</pre>');
      } else if (valuetype.indexOf('TRANSLATION') != -1)
      {
        ls.push('<div>' + P.BestTranslation(value) + '</div>');
      } else
      {    
        ls.push('<div>' + value + '</div>');
      }
    } else
    {
      if (valuetype == 'JSON')
      {
        ls.push('<td>' + JSON.stringify(value, null, 2) + '</td>');
      } else if (valuetype.indexOf('TRANSLATION') != -1)
      {
        ls.push('<td>' + P.BestTranslation(value) + '</td>');
      } else
      {    
        ls.push('<td>' + value + '</td>');
      }
    }
  }
}
"""
  
  # -------------------------------------------------------------------
  def __init__(self):
    super().__init__()