libervia-web: src/server/session

annotate src/server/session_iface.py @ 1064:abc5d545dbaa

pages (files): files sharing first draft: 2 subpages are available at the moment: - "list" to list shared files from an entity - "view" to request the file and send it via HTTP

author	Goffi <goffi@goffi.org>
date	Sun, 11 Mar 2018 19:33:38 +0100
parents	c2037b44f84e
children	9c41b7e91172

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
1054 f2170536ba23 date update Goffi <goffi@goffi.org> parents: 995 diff changeset	5 # Copyright (C) 2009-2018 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):
1055 c2037b44f84e server: fixed cache_dir for service profile in session interface Goffi <goffi@goffi.org> parents: 1054 diff changeset	47 if self.profile is None:
c2037b44f84e server: fixed cache_dir for service profile in session interface Goffi <goffi@goffi.org> parents: 1054 diff changeset	48 return self.service_cache_url + u'/'
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 964 diff changeset	49 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	50
960 e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	51 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	52 """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	53
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	54 @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	55 @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	56 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	57 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	58 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	59 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	60
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	61 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	62 """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	63
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	64 @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	65 @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	66 @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	67 @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	68 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	69 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	70 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	71 return default
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	72 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	73 if not page_data:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	74 # 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	75 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	76 return value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	77
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	78 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	79 """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	80
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	81 @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	82 @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	83 @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	84 @return (object): set value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	85 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	86 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	87 page_data[key] = value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	88 return value
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	89
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	90 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	91 """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	92
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	93 @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	94 @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	95 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	96 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	97 if flags is None:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	98 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	99 flags.add(flag)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	100
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	101 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	102 """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	103
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	104 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	105 @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	106 @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	107 @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	108 """
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	109 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	110 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	111 if flags is None:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	112 return False
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	113 if flag in flags:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	114 flags.remove(flag)
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	115 # 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	116 if not flags:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	117 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	118 if not page_data:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	119 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	120 return True
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	121 else:
e59edcae4c18 pages(session): added method to handle reload resistant page specific data: Goffi <goffi@goffi.org> parents: 957 diff changeset	122 return False
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	123
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	124
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	125 class ISATGuestSession(Interface):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	126 id = Attribute("UUID of the guest")
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	127 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	128
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	129
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	130 class SATGuestSession(object):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	131 implements(ISATGuestSession)
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	132
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	133 def __init__(self, session):
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	134 self.id = None
7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: diff changeset	135 self.data = None

Mercurial > libervia-web

annotate src/server/session_iface.py @ 1064:abc5d545dbaa