/usr/share/pyshared/archipelcore/archipelAvatarControllableEntity.py is in archipel-core 0.6.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | # -*- coding: utf-8 -*-
#
# archipelAvatarControllableEntity.py
#
# Copyright (C) 2010 Antoine Mercadal <antoine.mercadal@inframonde.eu>
# This file is part of ArchipelProject
# http://archipelproject.org
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import base64
import hashlib
import glob
import os
import xmpp
from archipelcore.utils import build_error_iq
ARCHIPEL_ERROR_CODE_AVATARS = -1
ARCHIPEL_ERROR_CODE_SET_AVATAR = -2
ARCHIPEL_NS_AVATAR = "archipel:avatar"
class TNAvatarControllableEntity (object):
"""
This class makes TNArchipelEntity avatar controllable.
It allows to get and set avatars of the entity.
"""
def __init__(self, configuration, permission_center, xmppclient, log):
"""
Initialize the TNAvatarControllableEntity.
@type configuration: configuration object
@param configuration: the configuration
@type permission_center: TNPermissionCenter
@param permission_center: the permission center of the entity
@type xmppclient: xmpp.Dispatcher
@param xmppclient: the entity xmpp client
@type log: TNArchipelLog
@param log: the logger of the entity
"""
self.configuration = configuration
self.b64Avatar = None
self.default_avatar = "default.png"
self.permission_center = permission_center
self.xmppclient = xmppclient
self.log = log
### subclass must implement this
def check_acp(conn, iq):
"""
Function that verify if the ACP is valid.
@type conn: xmpp.Dispatcher
@param conn: the connection
@type iq: xmpp.Protocol.Iq
@param iq: the IQ to check
@raise Exception: Exception if not implemented
"""
raise Exception("Subclass of TNAvatarControllableEntity must implement check_acp.")
def check_perm(self, conn, stanza, action_name, error_code=-1, prefix=""):
"""
Function that verify if the permissions are granted.
@type conn: xmpp.Dispatcher
@param conn: the connection
@type stanza: xmpp.Node
@param stanza: the stanza containing the action
@type action_name: string
@param action_name: the action to check
@type error_code: int
@param error_code: the error code to return
@type prefix: string
@param prefix: the prefix of the action
@raise Exception: Exception if not implemented
"""
raise Exception("Subclass of TNAvatarControllableEntity must implement check_perm.")
def set_vcard(self, params={}):
"""
Set the vcard of the entity.
@type params: dict
@param params: the parameters of the vCard
@raise Exception: Exception if not implemented
"""
raise Exception("Subclass of TNAvatarControllableEntity must implement set_vcard.")
def init_permissions(self):
"""
Initialize the Avatar permissions.
"""
self.permission_center.create_permission("getavatars", "Authorizes users to get entity avatars list", False)
self.permission_center.create_permission("setavatar", "Authorizes users to set entity's avatar", False)
def register_handlers(self):
"""
Initialize the avatar handlers.
"""
self.xmppclient.RegisterHandler('iq', self.process_avatar_iq, ns=ARCHIPEL_NS_AVATAR)
def unregister_handlers(self):
"""
Unregister the handlers.
"""
self.xmppclient.UnregisterHandler('iq', self.process_avatar_iq, ns=ARCHIPEL_NS_AVATAR)
### Avatars
def get_available_avatars(self, supported_file_extensions=["png", "jpg", "jpeg", "gif"]):
"""
Return a stanza with a list of availables avatars
base64 encoded.
"""
path = self.configuration.get("GLOBAL", "machine_avatar_directory")
resp = xmpp.Node("avatars")
for ctype in supported_file_extensions:
for img in glob.glob(os.path.join(path, "*.%s" % ctype)):
f = open(img, 'r')
data = base64.b64encode(f.read())
image_hash = hashlib.md5(data).hexdigest()
f.close()
node_img = resp.addChild(name="avatar", attrs={"name": img.split("/")[-1], "content-type": "image/%s" % ctype, "hash": image_hash})
node_img.setData(data)
return resp
def set_avatar(self, name):
"""
Change the current avatar of the entity.
@type name: string
@param name: the file name of avatar. base path is the configuration key "machine_avatar_directory"
"""
name = name.replace("..", "").replace("/", "").replace("\\", "").replace(" ", "_")
self.b64Avatar = None
self.set_vcard(params={"filename": name})
def b64avatar_from_filename(self, image):
"""
Create a base64 encoded avatar from filename.
@type image: string
@param image: relative file path of the image from conf token 'machine_avatar_directory'
@rtype: string
@return base64 encoded file content
"""
avatar_dir = self.configuration.get("GLOBAL", "machine_avatar_directory")
f = open(os.path.join(avatar_dir, image), "r")
photo_data = base64.b64encode(f.read())
f.close()
self.b64Avatar = photo_data
return self.b64Avatar
def process_avatar_iq(self, conn, iq):
"""
This method is invoked when a ARCHIPEL_NS_AVATAR IQ is received.
It understands IQ of type:
- alloc
- free
@type conn: xmpp.Dispatcher
@param conn: ths instance of the current connection that send the stanza
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
"""
reply = None
action = self.check_acp(conn, iq)
self.check_perm(conn, iq, action, -1)
if action == "getavatars":
reply = self.iq_get_available_avatars(iq)
elif action == "setavatar":
reply = self.iq_set_available_avatars(iq)
if reply:
conn.send(reply)
raise xmpp.protocol.NodeProcessed
def iq_get_available_avatars(self, iq):
"""
Return a list of availables avatars.
@type iq: xmpp.Protocol.Iq
@param iq: the IQ containing the request
"""
try:
reply = iq.buildReply("result")
reply.setQueryPayload([self.get_available_avatars()])
except Exception as ex:
reply = build_error_iq(self, ex, iq, ARCHIPEL_ERROR_CODE_AVATARS)
return reply
def iq_set_available_avatars(self, iq):
"""
Set the current avatar of the virtual machine.
@type iq: xmpp.Protocol.Iq
@param iq: the IQ containing the request
"""
try:
reply = iq.buildReply("result")
avatar = iq.getTag("query").getTag("archipel").getAttr("avatar")
self.set_avatar(avatar)
except Exception as ex:
reply = build_error_iq(self, ex, iq, ARCHIPEL_ERROR_CODE_SET_AVATAR)
return reply
|