libervia-web: src/server/session

annotate src/server/session_iface.py @ 995:f88325b56a6a

server: dynamic pages first draft: /!\ new dependency: autobahn This patch introduce server part of dynamic pages. Dynamic pages use websockets to establish constant connection with a Libervia page, allowing to receive real time data or update it. The feature is activated by specifying "dynamic = true" in the page. Once activated, page can implement "on_data" method which will be called when data are sent by the page. To send data the other way, the page can use request.sendData. The new "registerSignal" method allows to use an "on_signal" method to be called each time given signal is received, with automatic (and optional) filtering on profile. New renderPartial and renderAndUpdate method allow to append new HTML elements to the dynamic page.

author	Goffi <goffi@goffi.org>
date	Wed, 03 Jan 2018 01:10:12 +0100
parents	fd4eae654182
children	f2170536ba23

rev	line source
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	3
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	4 # Libervia: a SAT frontend
964 fd4eae654182 misc: date update (yes it's a bit late :p ) Goffi <goffi@goffi.org> parents: 960 diff changeset	5 # Copyright (C) 2009-2017 Jérôme Poisson (goffi@goffi.org)
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	6
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	11
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	16
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	19 from zope.interface import Interface, Attribute, implements
947 92f0eeb6dc72 pages: cache identities identities in session + get identities for comments in blog Goffi <goffi@goffi.org> parents: 919 diff changeset	20 from sat.tools.common import data_objects
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	21 from libervia.server.constants import Const as C
f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	22 import os.path
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	23 import shortuuid
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	24
960 e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	25 FLAGS_KEY = '_flags'
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	26
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	27 class ISATSession(Interface):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	28 profile = Attribute("Sat profile")
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	29 jid = Attribute("JID associated with the profile")
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	30 uuid = Attribute("uuid associated with the profile session")
947 92f0eeb6dc72 pages: cache identities identities in session + get identities for comments in blog Goffi <goffi@goffi.org> parents: 919 diff changeset	31 identities = Attribute("Identities of XMPP entities")
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	32
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	33
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	34 class SATSession(object):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	35 implements(ISATSession)
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	36
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	37 def __init__(self, session):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	38 self.profile = None
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	39 self.jid = None
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	40 self.uuid = unicode(shortuuid.uuid())
947 92f0eeb6dc72 pages: cache identities identities in session + get identities for comments in blog Goffi <goffi@goffi.org> parents: 919 diff changeset	41 self.identities = data_objects.Identities()
956 dabecab10faa server (pages): impleted CSRF protection: Goffi <goffi@goffi.org> parents: 947 diff changeset	42 self.csrf_token = unicode(shortuuid.uuid())
960 e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	43 self.pages_data = {} # used to keep data accross reloads (key is page instance)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	44
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	45 @property
f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	46 def cache_dir(self):
f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	47 return os.path.join(u'/', C.CACHE_DIR, self.uuid) + u'/'
f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	48
960 e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	49 def getPageData(self, page, key):
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	50 """get session data for a page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	51
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	52 @param page(LiberviaPage): instance of the page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	53 @param key(object): data key
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	54 return (None, object): value of the key
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	55 None if not found or page_data doesn't exist
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	56 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	57 return self.pages_data.get(page, {}).get(key)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	58
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	59 def popPageData(self, page, key, default=None):
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	60 """like getPageData, but remove key once value is gotten
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	61
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	62 @param page(LiberviaPage): instance of the page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	63 @param key(object): data key
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	64 @param default(object): value to return if key is not found
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	65 @return (object): found value or default
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	66 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	67 page_data = self.pages_data.get(page)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	68 if page_data is None:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	69 return default
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	70 value = page_data.pop(key, default)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	71 if not page_data:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	72 # no need to keep unused page_data
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	73 del self.pages_data[page]
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	74 return value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	75
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	76 def setPageData(self, page, key, value):
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	77 """set data to persist on reload
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	78
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	79 @param page(LiberviaPage): instance of the page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	80 @param key(object): data key
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	81 @param value(object): value to set
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	82 @return (object): set value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	83 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	84 page_data = self.pages_data.setdefault(page, {})
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	85 page_data[key] = value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	86 return value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	87
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	88 def setPageFlag(self, page, flag):
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	89 """set a flag for this page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	90
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	91 @param page(LiberviaPage): instance of the page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	92 @param flag(unicode): flag to set
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	93 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	94 flags = self.getPageData(page, FLAGS_KEY)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	95 if flags is None:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	96 flags = self.setPageData(page, FLAGS_KEY, set())
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	97 flags.add(flag)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	98
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	99 def popPageFlag(self, page, flag):
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	100 """return True if flag is set
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	101
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	102 flag is removed if it was set
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	103 @param page(LiberviaPage): instance of the page
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	104 @param flag(unicode): flag to set
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	105 @return (bool): True if flaag was set
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	106 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	107 page_data = self.pages_data.get(page, {})
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	108 flags = page_data.get(FLAGS_KEY)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	109 if flags is None:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	110 return False
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	111 if flag in flags:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	112 flags.remove(flag)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	113 # we remove data if they are not used anymore
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	114 if not flags:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	115 del page_data[FLAGS_KEY]
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	116 if not page_data:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	117 del self.pages_data[page]
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	118 return True
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	119 else:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	120 return False
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	121
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	122
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	123 class ISATGuestSession(Interface):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	124 id = Attribute("UUID of the guest")
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	125 data = Attribute("data associated with the guest")
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	126
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	127
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	128 class SATGuestSession(object):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	129 implements(ISATGuestSession)
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	130
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	131 def __init__(self, session):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	132 self.id = None
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	133 self.data = None

Mercurial > libervia-web

annotate src/server/session_iface.py @ 995:f88325b56a6a