session.py

Go to the documentation of this file.

#!/usr/bin/python
# -*- coding: utf-8 -*- 
 
import time
import datetime
 
from pafera.types import *
from pafera.validators import *
 
import pafera.modelbase
 
# Flags for the session object
SESSION_EXPIRED = 0x01
 
# *********************************************************************
# Bootstrap class for the database.
class system_useragent(pafera.modelbase.ModelBase):
  """Tracker for the various types of programs that visit the site.
  Note that this will not track every single visitor since sessions
  depend on JavaScript being enabled to load sessionvars.js, but can 
  be a good approximation of human visits.
  """
  
  _dbfields     = {
    'id':         ('INTEGER PRIMARY KEY AUTOINCREMENT', 'NOT NULL',),
    'header':     ('TEXT', 'NOT NULL', BlankValidator()),
    'platform':   ('TEXT', "NOT NULL DEFAULT ''", ),
    'browser':    ('TEXT', "NOT NULL DEFAULT ''", ),
    'version':    ('TEXT', "NOT NULL DEFAULT ''", ),
    'flags':      ('INT', 'NOT NULL DEFAULT 0',),
  }
  _dbindexes  = (
  )
  _dblinks    = []
  _dbdisplay  = ['platform', 'browser', 'version']
  _dbflags    = 0
  
  # -------------------------------------------------------------------
  def __init__(self):
    super().__init__()
 
# *********************************************************************
class system_session(pafera.modelbase.ModelBase):
  """Keeps track of user sessions, language selection, and application
  data.
  
  This class also has the ability to record every URL that the user
  visited and how long they stayed on that page if 
  g.siteconfig['urltracking'] is enabled. It makes the system a bit 
  slower, but gives you much better analysis of what the user did and
  what they were interested in.
  """
  
  _dbfields     = {
    'rbid':         ('BIGINT PRIMARY KEY', 'NOT NULL',),
    'userid':       ('INT', 'NOT NULL DEFAULT 0',),
    'useragentid':  ('INT', 'NOT NULL',),
    'length':       ('INT', 'NOT NULL DEFAULT 0',),
    'flags':        ('INT', 'NOT NULL DEFAULT 0',),
    'ip':           ('TEXT', 'NOT NULL', BlankValidator()),
    'lang':         ('TEXT', 'NOT NULL', BlankValidator()),
    'langcodes':    ('LIST', 'NOT NULL', BlankValidator()),
    'data':         ('DICT', "NOT NULL DEFAULT ''",),
    'starttime':    ('DATETIME', 'NOT NULL',),
    'endtime':      ('DATETIME', 'NOT NULL DEFAULT 0',),
    'urls':         ('LIST', "NOT NULL DEFAULT ''",),
  }
  _dbindexes  = (
  )
  _dblinks    = []
  _dbdisplay  = ['userid', 'length', 'lang', 'starttime']
  _dbflags    = 0
  
  # -------------------------------------------------------------------
  def __init__(self):
    super().__init__()
    
    self.data       = {}
    self.urls       = []
    self.needupdate = 0
  
  # -------------------------------------------------------------------
  def CheckExpired(self, g):
    """See if the current session has expired and creates a new one if
    necessary.
    """
    currenttime = time.time()
    
    if currenttime > self.endtime.timestamp() + IntV(g.siteconfig, 'sessiontimeout', 600, 2678400, 604800):
      self.New(g)
      '''with open('expired.log', 'a+') as f:
        f.write(f""">>> Session {self.rbid} expired:
  User ID:\t{g.session.userid}
  Current Time:\t{currenttime}
  End Time:\t{self.endtime.timestamp()}
  Length:\t{currenttime - self.starttime.timestamp()}
  Session Timeout:\t{IntV(g.siteconfig, 'sessiontimeout', 600, 2678400, 604800)}\n""")
      '''  
    
  # -------------------------------------------------------------------
  def New(self, g):
    """Creates a new session, closing the old session.
    
    This also setups the useragent, languages, and other default settings. 
    """
    currenttime = time.time()
    
    if self.rbid:
      self.Set(
        endtime   = currenttime,
        length    = currenttime - self.starttime.timestamp(),
        flags     = SESSION_EXPIRED,
      )
      g.db.Update(self)
      g.db.Commit()
      
      self.Set(
        rbid    = 0,
        userid  = 0,
      )
      
    req   = g.request 
    ua    = g.request.user_agent
    
    useragent = g.db.Find(system_useragent, 'WHERE header = ?', ua.string)
    
    # Some testing tools don't provide platform, browser, and such.
    # Therefore, we use blank values instead.
    if not useragent:
      useragent = system_useragent()
      useragent.Set(
        header      = ua.string,
        platform    = ua.platform if ua.platform else '',
        browser     = ua.browser if ua.browser else '',
        version     = ua.version if ua.version else '',
        flags       = 0,
      )
      g.db.Insert(useragent)
      g.db.Commit()
    else:
      useragent = useragent[0]
      
    lang  = req.accept_languages.best_match(g.siteconfig['languages'])
    
    if not lang:
      lang  = 'en'
      
    langcodes = list(g.request.accept_languages.values())
    
    if not langcodes:
      langcodes = ['en']
      
    self.Set(
      userid        = 0,
      useragentid   = useragent.id,
      ip            = req.environ['HTTP_X_FORWARDED_FOR'] if req.environ.get('HTTP_X_FORWARDED_FOR') else req.environ['REMOTE_ADDR'],
      lang          = lang,
      langcodes     = langcodes,
      length        = 0,
      starttime     = currenttime,
      endtime       = currenttime,
      flags         = 0,
      urls          = [],
      data          = {
        'texttheme':    'default',
        'wallpaper':    'blue',
        'usericon':     '',
        'groups':       [],
      },
    )
    
    g.db.Insert(self)
    g.db.Commit()
    
  # -------------------------------------------------------------------
  def __getitem__(self, key):
    """Convenience functions to allow the session object to be used as 
    a dict that saves settings at the end of the script.
    """
    
    if key in self.data:
      return self.data[key]
    
    return None
  
  # -------------------------------------------------------------------
  def __setitem__(self, key, value):
    """Convenience functions to allow the session object to be used as 
    a dict that saves settings at the end of the script.
    """
    if key in self.data:
      if self.data[key] == value:
        return
    
    self.data[key]    = value
    self._datachanged  = 1
    
  # -------------------------------------------------------------------
  def __delitem__(self, key):
    """Convenience functions to allow the session object to be used as 
    a dict that saves settings at the end of the script.
    """
    if key in self.data:
      del self.data[key]
      
  # -------------------------------------------------------------------
  def get(self, key, defaultvalue = None):
    """Convenience functions to allow the session object to be used as 
    a dict that saves settings at the end of the script.
    """
    return self.data.get(key, defaultvalue)