Forked mumble-django project from https://bitbucket.org/Svedrin/mumble-django
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

932 lines
37 KiB

16 years ago
16 years ago
16 years ago
16 years ago
16 years ago
16 years ago
16 years ago
  1. # kate: space-indent on; indent-width 4; replace-tabs on;
  2. """
  3. * Copyright © 2009-2010, Michael "Svedrin" Ziegler <diese-addy@funzt-halt.net>
  4. *
  5. * Mumble-Django is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This package is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. """
  15. import re
  16. import datetime
  17. from time import time
  18. from sys import stderr
  19. from urllib import urlopen
  20. from StringIO import StringIO
  21. from PIL import Image
  22. from django.utils.translation import ugettext_noop, ugettext_lazy as _
  23. from django.contrib.auth.models import User
  24. from django.db import models
  25. from django.db.models import signals
  26. from django.conf import settings
  27. from django.utils.encoding import smart_str
  28. from mumble.mmobjects import mmChannel, mmPlayer
  29. from mumble.mctl import MumbleCtlBase
  30. def mk_config_property( field, doc="", get_coerce=None, get_none=None, set_coerce=unicode, set_none='' ):
  31. """ Create a property for the given config field. """
  32. def get_field( self ):
  33. if self.id is not None:
  34. val = self.getConf( field )
  35. if val is None or val == '':
  36. return get_none
  37. if callable(get_coerce):
  38. return get_coerce( val )
  39. return val
  40. return None
  41. def set_field( self, value ):
  42. if value is None:
  43. self.setConf( field, set_none )
  44. elif callable(set_coerce):
  45. self.setConf( field, set_coerce(value) )
  46. else:
  47. self.setConf( field, value )
  48. return property( get_field, set_field, doc=doc )
  49. def mk_config_bool_property( field, doc="" ):
  50. return mk_config_property( field, doc=doc,
  51. get_coerce = lambda value: value == "true",
  52. set_coerce = lambda value: str(value).lower()
  53. )
  54. class MumbleServer( models.Model ):
  55. """ Represents a Murmur server installation. """
  56. dbus = models.CharField( _('DBus or ICE base'), max_length=200, unique=True, default=settings.DEFAULT_CONN, help_text=_(
  57. "Examples: 'net.sourceforge.mumble.murmur' for DBus or 'Meta:tcp -h 127.0.0.1 -p 6502' for Ice.") )
  58. secret = models.CharField( _('Ice Secret'), max_length=200, blank=True )
  59. class Meta:
  60. verbose_name = _('Mumble Server')
  61. verbose_name_plural = _('Mumble Servers')
  62. def __init__( self, *args, **kwargs ):
  63. models.Model.__init__( self, *args, **kwargs )
  64. self._ctl = None
  65. self._conf = None
  66. self._version = None
  67. def __unicode__( self ):
  68. return self.dbus
  69. # Ctl instantiation
  70. def getCtl( self ):
  71. """ Instantiate and return a MumbleCtl object for this server.
  72. Only one instance will be created, and reused on subsequent calls.
  73. """
  74. if not self._ctl:
  75. self._ctl = MumbleCtlBase.newInstance( self.dbus, settings.SLICE, self.secret )
  76. return self._ctl
  77. ctl = property( getCtl, doc="Get a Control object for this server. The ctl is cached for later reuse." )
  78. def isMethodDbus(self):
  79. """ Return true if this instance uses DBus. """
  80. rd = re.compile( r'^(\w+\.)*\w+$' )
  81. return bool(rd.match(self.dbus))
  82. method_dbus = property( isMethodDbus )
  83. method_ice = property( lambda self: not self.isMethodDbus(), doc="Return true if this instance uses Ice." )
  84. def getDefaultConf( self, field=None ):
  85. """ Get a field from the default conf dictionary, or None if the field isn't set. """
  86. if self._conf is None:
  87. self._conf = self.ctl.getDefaultConf()
  88. if field is None:
  89. return self._conf
  90. if field in self._conf:
  91. return self._conf[field]
  92. return None
  93. def isOnline( self ):
  94. """ Return true if this server process is running. """
  95. possibleexceptions = []
  96. try:
  97. from Ice import ConnectionRefusedException
  98. except ImportError, err:
  99. if self.method_ice:
  100. print >> stderr, err
  101. return None
  102. else:
  103. possibleexceptions.append( ConnectionRefusedException )
  104. try:
  105. from dbus import DBusException
  106. except ImportError, err:
  107. if self.method_dbus:
  108. print >> stderr, err
  109. return None
  110. else:
  111. possibleexceptions.append( DBusException )
  112. try:
  113. self.ctl
  114. except tuple(possibleexceptions), err:
  115. print >> stderr, err
  116. return False
  117. except (EnvironmentError, RuntimeError), err:
  118. print >> stderr, err
  119. return None
  120. else:
  121. return True
  122. online = property( isOnline )
  123. defaultconf = property( getDefaultConf, doc="The default config dictionary." )
  124. def getDefaultPort( self ):
  125. """ Return the default port configured on this server. """
  126. if "port" in self.defaultconf:
  127. return int(self.defaultconf['port'])
  128. else:
  129. return settings.MUMBLE_DEFAULT_PORT
  130. defaultPort = property( getDefaultPort )
  131. def getVersion( self ):
  132. """ Return the version of Murmur. """
  133. if self._version is None:
  134. self._version = self.ctl.getVersion()
  135. return self._version
  136. version = property( getVersion )
  137. prettyversion = property( lambda self: '.'.join( map( str, self.version[:3] ) ),
  138. doc="Pretty-Printed version" )
  139. def save( self, run_detection=True, verbosity=0, *args, **kwargs ):
  140. ret = models.Model.save( self, *args, **kwargs )
  141. if not run_detection:
  142. return ret
  143. servIDs = self.ctl.getAllServers()
  144. unseen_ids = [rec["srvid"] for rec in Mumble.objects.values( "srvid" )]
  145. for id in servIDs:
  146. if id in unseen_ids:
  147. unseen_ids.remove(id)
  148. if verbosity > 1:
  149. print "Checking Murmur instance with id %d." % id
  150. # first check that the server has not yet been inserted into the DB
  151. try:
  152. instance = Mumble.objects.get( server=self, srvid=id )
  153. except Mumble.DoesNotExist:
  154. if verbosity:
  155. print "Found new Murmur instance %d on bus '%s'... " % ( id, self.dbus )
  156. # now create a model for the record set (configureFromMurmur will save() it).
  157. instance = Mumble( server=self, srvid=id )
  158. else:
  159. if verbosity:
  160. print "Syncing Murmur instance %d: '%s'... " % ( instance.id, instance.name )
  161. try:
  162. instance.configureFromMurmur()
  163. except DatabaseError, err:
  164. try:
  165. # Find instances with the same address/port
  166. dup = Mumble.objects.get( addr=instance.addr, port=instance.port )
  167. except Mumble.DoesNotExist:
  168. # None exist - this must've been something else.
  169. if verbosity:
  170. print "Server ID / Name: %d / %s" % ( instance.srvid, instance.name )
  171. raise err
  172. else:
  173. if verbosity:
  174. print "ERROR: There is already another server instance registered"
  175. print " on the same address and port."
  176. print " -------------"
  177. print " New Server ID:", instance.srvid,
  178. print " New Server Name:", instance.name
  179. print " Address:", instance.addr
  180. print " Port:", instance.port
  181. print " Connection string:", instance.server.dbus
  182. print " -------------"
  183. print " Duplicate Server ID:", dup.srvid,
  184. print "Duplicate Server Name:", dup.name
  185. print " Address:", dup.addr
  186. print " Port:", dup.port
  187. print " Connection string:", dup.server.dbus
  188. raise err
  189. except Exception, err:
  190. if verbosity:
  191. print "Server ID / Name: %d / %s" % ( instance.srvid, instance.name )
  192. raise err
  193. # Now search for players on this server that have not yet been registered
  194. if instance.booted:
  195. if verbosity > 1:
  196. print "Looking for registered Players on Server id %d." % id
  197. instance.readUsersFromMurmur( verbose=verbosity )
  198. elif verbosity:
  199. print "This server is not running, can't sync players."
  200. signals.pre_delete.disconnect( Mumble.pre_delete_listener, sender=Mumble )
  201. for srvid in unseen_ids:
  202. mm = Mumble.objects.get( srvid=srvid )
  203. if verbosity:
  204. print 'Found stale Mumble instance "%s".' % mm.name
  205. mm.delete()
  206. signals.pre_delete.connect( Mumble.pre_delete_listener, sender=Mumble )
  207. return ret
  208. class Mumble( models.Model ):
  209. """ Represents a Murmur server instance.
  210. All configurable settings are represented by a field in this model. To change the
  211. settings, just update the appropriate field and call the save() method.
  212. To set up a new server instance, instanciate and save this Model.
  213. When an instance of this model is deleted, the according server instance will be
  214. deleted as well.
  215. """
  216. server = models.ForeignKey( MumbleServer, verbose_name=_("Mumble Server") )
  217. name = models.CharField( _('Server Name'), max_length=200 )
  218. srvid = models.IntegerField( _('Server ID'), editable=False )
  219. addr = models.CharField( _('Server Address'), max_length=200, blank=True, help_text=_(
  220. "Hostname or IP address to bind to. You should use a hostname here, because it will appear on the "
  221. "global server list.") )
  222. port = models.IntegerField( _('Server Port'), blank=True, null=True, help_text=_(
  223. "Port number to bind to. Leave empty to auto assign one.") )
  224. display = models.CharField( _('Server Display Address'), max_length=200, blank=True, help_text=_(
  225. "This field is only relevant if you are located behind a NAT, and names the Hostname or IP address "
  226. "to use in the Channel Viewer and for the global server list registration. If not given, the addr "
  227. "and port fields are used. If display and bind ports are equal, you can omit it here.") )
  228. supw = property( lambda self: '',
  229. lambda self, value: ( value and self.ctl.setSuperUserPassword( self.srvid, value ) ) or None,
  230. doc=_('Superuser Password')
  231. )
  232. url = mk_config_property( "registerurl", ugettext_noop("Website URL") )
  233. motd = mk_config_property( "welcometext", ugettext_noop("Welcome Message") )
  234. passwd = mk_config_property( "password", ugettext_noop("Server Password") )
  235. users = mk_config_property( "users", ugettext_noop("Max. Users"), get_coerce=int )
  236. bwidth = mk_config_property( "bandwidth", ugettext_noop("Bandwidth [Bps]"), get_coerce=int )
  237. sslcrt = mk_config_property( "certificate", ugettext_noop("SSL Certificate") )
  238. sslkey = mk_config_property( "key", ugettext_noop("SSL Key") )
  239. player = mk_config_property( "username", ugettext_noop("Player name regex") )
  240. channel = mk_config_property( "channelname", ugettext_noop("Channel name regex") )
  241. defchan = mk_config_property( "defaultchannel", ugettext_noop("Default channel"), get_coerce=int )
  242. timeout = mk_config_property( "timeout", ugettext_noop("Timeout"), get_coerce=int )
  243. textlen = mk_config_property( "textmessagelength", ugettext_noop("Maximum length of text messages") )
  244. usersperchannel = mk_config_property( "usersperchannel",ugettext_noop("Users per channel"), get_coerce=int )
  245. sgversion = mk_config_property( "suggestversion", ugettext_noop("Version to recommend") )
  246. certreq = mk_config_bool_property( "certrequired", ugettext_noop("Require Certificate") )
  247. html = mk_config_bool_property( "allowhtml", ugettext_noop("Allow HTML to be used in messages") )
  248. bonjour = mk_config_bool_property( "bonjour", ugettext_noop("Publish this server via Bonjour") )
  249. autoboot= mk_config_bool_property( "boot", ugettext_noop("Boot Server when Murmur starts") )
  250. rememchn= mk_config_bool_property( "rememberchannel", ugettext_noop("Remember last channel") )
  251. sgpositional= mk_config_bool_property( "suggestpositional", ugettext_noop("Suggest to use positional audio") )
  252. sgptt = mk_config_bool_property( "suggestpushtotalk", ugettext_noop("Suggest to use Push-To-Talk") )
  253. def get_absolute_url( self ):
  254. from views import show
  255. from django.core.urlresolvers import reverse
  256. return reverse( show, kwargs={ 'server': self.id } )
  257. def getBooted( self ):
  258. if self.id is not None:
  259. if self.server.online:
  260. return self.ctl.isBooted( self.srvid )
  261. else:
  262. return None
  263. else:
  264. return False
  265. def setBooted( self, value ):
  266. if value != self.getBooted():
  267. if value:
  268. self.ctl.start( self.srvid )
  269. else:
  270. self.ctl.stop( self.srvid )
  271. booted = property( getBooted, setBooted, doc=ugettext_noop("Boot Server") )
  272. online = property( getBooted, setBooted, doc=ugettext_noop("Boot Server") )
  273. defaultPort = property( lambda self: self.server.defaultPort + self.srvid - 1,
  274. doc="Default port for this server instance" )
  275. boundPort = property( lambda self: self.port or self.defaultPort,
  276. doc="The port that this instance actually binds to" )
  277. class Meta:
  278. unique_together = ( ( 'server', 'srvid' ), )
  279. verbose_name = _('Server instance')
  280. verbose_name_plural = _('Server instances')
  281. def __unicode__( self ):
  282. if not self.id:
  283. return u'Murmur "%s" (NOT YET CREATED)' % self.name
  284. return u'Murmur "%s" (%d)' % ( self.name, self.srvid )
  285. def save( self, dontConfigureMurmur=False, *args, **kwargs ):
  286. """ Save the options configured in this model instance not only to Django's database,
  287. but to Murmur as well.
  288. """
  289. if dontConfigureMurmur:
  290. return models.Model.save( self, *args, **kwargs )
  291. if self.id is None:
  292. self.srvid = self.ctl.newServer()
  293. self.ctl.setConf( self.srvid, 'registername', self.name )
  294. if self.addr:
  295. self.ctl.setConf( self.srvid, 'host', self.addr )
  296. else:
  297. self.ctl.setConf( self.srvid, 'host', '' )
  298. if self.port and self.port != self.defaultPort:
  299. self.ctl.setConf( self.srvid, 'port', str(self.port) )
  300. else:
  301. self.ctl.setConf( self.srvid, 'port', '' )
  302. if self.display:
  303. # if self.display contains a port, we're screwed here...
  304. self.ctl.setConf( self.srvid, 'registerhostname', self.display )
  305. elif self.addr:
  306. # If Murmur binds to multiple addresses, use the first
  307. self.ctl.setConf( self.srvid, 'registerhostname', self.addr.split(" ")[0] )
  308. else:
  309. self.ctl.setConf( self.srvid, 'registerhostname', '' )
  310. return models.Model.save( self, *args, **kwargs )
  311. def __init__( self, *args, **kwargs ):
  312. models.Model.__init__( self, *args, **kwargs )
  313. self._channels = None
  314. self._rootchan = None
  315. users_regged = property( lambda self: self.mumbleuser_set.count(), doc="Number of registered users." )
  316. users_online = property( lambda self: len(self.ctl.getPlayers(self.srvid)), doc="Number of online users." )
  317. channel_cnt = property( lambda self: len(self.ctl.getChannels(self.srvid)), doc="Number of channels." )
  318. is_public = property( lambda self: not self.passwd,
  319. doc="False if a password is needed to join this server." )
  320. uptime = property( lambda self: self.ctl.getUptime(self.srvid),
  321. doc="Number of seconds this instance has been running." )
  322. @property
  323. def upsince(self):
  324. """Datetime since when the server is running."""
  325. if self.uptime is not None:
  326. return datetime.datetime.fromtimestamp( float( time() - self.uptime ) )
  327. return None
  328. is_server = True
  329. is_channel = False
  330. is_player = False
  331. ctl = property( lambda self: self.server.ctl )
  332. def getBans( self ):
  333. return self.ctl.getBans( self.srvid )
  334. def removeBan( self, **kwargs ):
  335. return self.ctl.removeBan( self.srvid, **kwargs )
  336. def getConf( self, field ):
  337. return self.ctl.getConf( self.srvid, field )
  338. def setConf( self, field, value ):
  339. return self.ctl.setConf( self.srvid, field, value )
  340. def configureFromMurmur( self ):
  341. conf = self.ctl.getAllConf( self.srvid )
  342. if "registername" not in conf or not conf["registername"]:
  343. self.name = "noname"
  344. else:
  345. self.name = conf["registername"]
  346. if "host" in conf:
  347. self.addr = conf["host"]
  348. else:
  349. self.addr = ""
  350. if "port" in conf:
  351. self.port = int(conf["port"])
  352. else:
  353. self.port = None
  354. if "registerhostname" in conf and conf["registerhostname"] != self.addr:
  355. self.display = conf["registerhostname"]
  356. if ' ' in self.addr and self.display == self.addr.split(' ')[0]:
  357. self.display = ""
  358. else:
  359. self.display = ""
  360. self.save( dontConfigureMurmur=True )
  361. def readUsersFromMurmur( self, verbose=0 ):
  362. if not self.booted:
  363. raise SystemError( "This murmur instance is not currently running, can't sync." )
  364. players = self.ctl.getRegisteredPlayers(self.srvid)
  365. unseen_ids = [rec["mumbleid"]
  366. for rec in MumbleUser.objects.filter( server=self ).values( "mumbleid" )
  367. ]
  368. for idx in players:
  369. playerdata = players[idx]
  370. if playerdata.userid == 0: # Skip SuperUsers
  371. continue
  372. if verbose > 1:
  373. print "Checking User with id %d." % playerdata.userid
  374. if playerdata.userid not in unseen_ids:
  375. if verbose:
  376. print 'Found new User "%s".' % smart_str(playerdata.name)
  377. playerinstance = MumbleUser(
  378. mumbleid = playerdata.userid,
  379. name = playerdata.name,
  380. password = '',
  381. server = self,
  382. owner = None
  383. )
  384. else:
  385. if verbose > 1:
  386. print "User '%s' is already known." % smart_str(playerdata.name)
  387. unseen_ids.remove(playerdata.userid)
  388. playerinstance = MumbleUser.objects.get( server=self, mumbleid=playerdata.userid )
  389. playerinstance.name = playerdata.name
  390. playerinstance.save( dontConfigureMurmur=True )
  391. signals.pre_delete.disconnect( MumbleUser.pre_delete_listener, sender=MumbleUser )
  392. for uid in unseen_ids:
  393. mu = MumbleUser.objects.get( mumbleid=uid )
  394. if verbose:
  395. print 'Found stale MumbleUser "%s".' % mu.name
  396. mu.delete()
  397. signals.pre_delete.connect( MumbleUser.pre_delete_listener, sender=MumbleUser )
  398. def isUserAdmin( self, user ):
  399. """ Determine if the given user is an admin on this server. """
  400. if user.is_authenticated():
  401. if user.is_superuser:
  402. return True
  403. try:
  404. return self.mumbleuser_set.get( owner=user ).getAdmin()
  405. except MumbleUser.DoesNotExist:
  406. return False
  407. return False
  408. # Deletion handler
  409. def deleteServer( self ):
  410. """ Delete this server instance from Murmur. """
  411. self.ctl.deleteServer(self.srvid)
  412. @staticmethod
  413. def pre_delete_listener( **kwargs ):
  414. kwargs['instance'].deleteServer()
  415. # Channel list
  416. def getChannels( self ):
  417. """ Query the channels from Murmur and create a tree structure.
  418. Again, this will only be done for the first call to this function. Subsequent
  419. calls will simply return the list created last time.
  420. """
  421. if self._channels is None:
  422. self._channels = {}
  423. chanlist = self.ctl.getChannels(self.srvid).values()
  424. links = {}
  425. # sometimes, ICE seems to return the Channel list in a weird order.
  426. # itercount prevents infinite loops.
  427. itercount = 0
  428. maxiter = len(chanlist) * 3
  429. while len(chanlist) and itercount < maxiter:
  430. itercount += 1
  431. for theChan in chanlist:
  432. # Channels - Fields: 0 = ID, 1 = Name, 2 = Parent-ID, 3 = Links
  433. if( theChan.parent == -1 ):
  434. # No parent
  435. self._channels[theChan.id] = mmChannel( self, theChan )
  436. elif theChan.parent in self.channels:
  437. # parent already known
  438. self._channels[theChan.id] = mmChannel( self, theChan, self.channels[theChan.parent] )
  439. else:
  440. continue
  441. chanlist.remove( theChan )
  442. self._channels[theChan.id].serverId = self.id
  443. # process links - if the linked channels are known, link; else save their ids to link later
  444. for linked in theChan.links:
  445. if linked in self._channels:
  446. self._channels[theChan.id].linked.append( self._channels[linked] )
  447. else:
  448. if linked not in links:
  449. links[linked] = list()
  450. links[linked].append( self._channels[theChan.id] )
  451. # check if earlier round trips saved channel ids to be linked to the current channel
  452. if theChan.id in links:
  453. for targetChan in links[theChan.id]:
  454. targetChan.linked.append( self._channels[theChan.id] )
  455. self._channels[0].name = self.name
  456. self.players = {}
  457. for thePlayer in self.ctl.getPlayers(self.srvid).values():
  458. # Players - Fields: 0 = UserID, 6 = ChannelID
  459. self.players[ thePlayer.session ] = mmPlayer( self, thePlayer, self._channels[ thePlayer.channel ] )
  460. self._channels[0].sort()
  461. return self._channels
  462. channels = property( getChannels, doc="A convenience wrapper for getChannels()." )
  463. rootchan = property( lambda self: self.channels[0], doc="A convenience wrapper for getChannels()[0]." )
  464. def getNetloc( self ):
  465. """ Return the address from the Display field (if any), or the server address.
  466. Users from outside a NAT will need to use the Display address to connect
  467. to this server instance.
  468. """
  469. if self.display:
  470. # Find out if this is a sensible address *with port*.
  471. # Regex checks for (hostname OR [ipv6] OR ipv4):port.
  472. if re.match( r'^([^:]+|\[[\da-fA-F]{0,4}(:[\da-fA-F]{0,4})+\]|\d{1,3}(\.\d{1,3}){3}):\d{1,5}$', self.display):
  473. return self.display
  474. else:
  475. daddr = self.display
  476. elif " " in self.addr:
  477. # If Murmur binds to multiple addresses, use the first
  478. daddr = self.addr.split(" ")[0]
  479. else:
  480. daddr = self.addr
  481. if ":" in daddr:
  482. # []-escape IPv6 addresses
  483. daddr = "[%s]" % daddr
  484. if self.boundPort != settings.MUMBLE_DEFAULT_PORT:
  485. return "%s:%d" % (daddr, self.boundPort)
  486. else:
  487. return daddr
  488. netloc = property( getNetloc )
  489. def getURL( self, forUser = None ):
  490. """ Create an URL of the form mumble://username@host:port/ for this server. """
  491. if not self.netloc:
  492. return None
  493. from urlparse import urlunsplit
  494. versionstr = "version=%s" % self.prettyversion
  495. if forUser is not None:
  496. netloc = "%s@%s" % ( forUser.name, self.netloc )
  497. return urlunsplit(( "mumble", netloc, "", versionstr, "" ))
  498. else:
  499. return urlunsplit(( "mumble", self.netloc, "", versionstr, "" ))
  500. connecturl = property( getURL )
  501. version = property( lambda self: self.server.version, doc="The version of Murmur." )
  502. prettyversion = property( lambda self: self.server.prettyversion )
  503. def asDict( self, authed=False ):
  504. return { 'name': self.name,
  505. 'id': self.id,
  506. 'root': self.rootchan.asDict( authed ),
  507. 'x_connecturl': self.connecturl,
  508. 'x_uptime': self.uptime,
  509. }
  510. def asXml( self, authed=False ):
  511. from xml.etree.cElementTree import Element
  512. root = Element( "server",
  513. xmlns="http://mumble.sourceforge.net/Channel_Viewer_Protocol",
  514. id=unicode(self.id), name=self.name
  515. )
  516. root.set( 'x_connecturl', self.connecturl )
  517. root.set( 'x_uptime', unicode(self.uptime) )
  518. root.set( 'xmlns:xsi', "http://www.w3.org/2001/XMLSchema-instance" )
  519. root.set( 'xsi:schemaLocation',
  520. "http://bitbucket.org/Svedrin/mumble-django/wiki/channel-viewer-protocol_murmur-%d-%d-%d.xsd" % self.version[:3]
  521. )
  522. self.rootchan.asXml( root, authed )
  523. return root
  524. def asMvXml( self ):
  525. """ Return an XML tree for this server suitable for MumbleViewer-ng. """
  526. from xml.etree.cElementTree import Element
  527. root = Element("root")
  528. self.rootchan.asMvXml(root)
  529. return root
  530. def asMvJson( self ):
  531. """ Return a Dict for this server suitable for MumbleViewer-ng. """
  532. return self.rootchan.asMvJson()
  533. # "server" field protection
  534. def __setattr__( self, name, value ):
  535. if name == 'server':
  536. if self.id is not None and self.server != value:
  537. raise AttributeError( _( "This field must not be updated once the record has been saved." ) )
  538. models.Model.__setattr__( self, name, value )
  539. def kickUser( self, sessionid, reason="" ):
  540. return self.ctl.kickUser( self.srvid, sessionid, reason )
  541. def banUser( self, sessionid, reason="", duration=0 ):
  542. return self.ctl.addBanForSession( self.srvid, sessionid, reason=reason, duration=duration )
  543. def moveUser( self, sessionid, channelid ):
  544. return self.ctl.moveUser( self.srvid, sessionid, channelid )
  545. def muteUser( self, sessionid, mute=True ):
  546. return self.ctl.muteUser( self.srvid, sessionid, mute )
  547. def deafenUser( self, sessionid, deafen=True ):
  548. return self.ctl.deafenUser( self.srvid, sessionid, deafen )
  549. def sendMessage( self, sessionid, message ):
  550. return self.ctl.sendMessage( self.srvid, sessionid, message )
  551. def sendMessageChannel( self, channelid, tree, message ):
  552. return self.ctl.sendMessageChannel( self.srvid, channelid, tree, message )
  553. def hasUserTexture( self, userid ):
  554. """ Check if this user has a texture set. """
  555. if userid == -1:
  556. return False
  557. try:
  558. self.getUserTexture( userid )
  559. except ValueError:
  560. return False
  561. else:
  562. return True
  563. def getUserTexture( self, userid ):
  564. return self.ctl.getTexture( self.srvid, userid )
  565. def setUserTexture( self, userid, image ):
  566. return self.ctl.setTexture( self.srvid, userid, image )
  567. def addChannel( self, name, parentid ):
  568. regex = (self.channel or self.server.getDefaultConf()['channelname'])
  569. if regex and not re.match( regex, name ):
  570. raise NameError(_("That name is forbidden by the server."))
  571. return self.ctl.addChannel( self.srvid, name, parentid )
  572. def removeChannel( self, channelid ):
  573. return self.ctl.removeChannel( self.srvid, channelid )
  574. def renameChannel( self, channelid, name, description ):
  575. regex = (self.channel or self.server.getDefaultConf()['channelname'])
  576. if regex and not re.match( regex, name ):
  577. raise NameError(_("That name is forbidden by the server."))
  578. return self.ctl.renameChannel( self.srvid, channelid, name, description )
  579. def moveChannel( self, channelid, parentid ):
  580. return self.ctl.moveChannel( self.srvid, channelid, parentid )
  581. def getLog( self, first=0, last=100, filter="" ):
  582. """ Return log entries from ``first`` to ``last`` that contain ``filter`` (if any). """
  583. logentries = self.ctl.getLog( self.srvid, first, last )
  584. if not filter:
  585. return logentries
  586. return [ logentry for logentry in logentries if filter in logentry.txt ]
  587. def mk_registration_property( field, doc="" ):
  588. """ Create a property for the given registration field. """
  589. def get_field( self ):
  590. if field in self.registration:
  591. return self.registration[field]
  592. else:
  593. return None
  594. return property( get_field, doc=doc )
  595. class MumbleUser( models.Model ):
  596. """ Represents a User account in Murmur.
  597. To change an account, simply set the according field in this model and call the save()
  598. method to update the account in Murmur and in Django's database. Note that, once saved
  599. for the first time, the server field must not be changed. Attempting to do this will
  600. result in an AttributeError. To move an account to a new server, recreate it on the
  601. new server and delete the old model.
  602. When you delete an instance of this model, the according user account will be deleted
  603. in Murmur as well, after revoking the user's admin privileges.
  604. """
  605. mumbleid = models.IntegerField( _('Mumble player_id'), editable = False, default = -1 )
  606. name = models.CharField( _('User name and Login'), max_length = 200 )
  607. password = models.CharField( _('Login password'), max_length = 200, blank=True )
  608. server = models.ForeignKey( Mumble, verbose_name=_('Server instance'), related_name="mumbleuser_set" )
  609. owner = models.ForeignKey( User, verbose_name=_('Account owner'), related_name="mumbleuser_set", null=True, blank=True )
  610. comment = mk_registration_property( "comment", doc=ugettext_noop("The user's comment.") )
  611. hash = mk_registration_property( "hash", doc=ugettext_noop("The user's hash.") )
  612. gravatar256 = property( lambda self: self.gravatarUrl( size=256 ) )
  613. gravatar128 = property( lambda self: self.gravatarUrl( size=128 ) )
  614. gravatar64 = property( lambda self: self.gravatarUrl( size=64 ) )
  615. gravatar = property( lambda self: self.gravatarUrl() )
  616. class Meta:
  617. unique_together = ( ( 'server', 'owner' ), ( 'server', 'mumbleid' ) )
  618. verbose_name = _( 'User account' )
  619. verbose_name_plural = _( 'User accounts' )
  620. is_server = False
  621. is_channel = False
  622. is_player = True
  623. def __unicode__( self ):
  624. return _("Mumble user %(mu)s on %(srv)s owned by Django user %(du)s") % {
  625. 'mu': self.name,
  626. 'srv': self.server,
  627. 'du': self.owner
  628. }
  629. def save( self, dontConfigureMurmur=False, *args, **kwargs ):
  630. """ Save the settings in this model to Murmur. """
  631. if dontConfigureMurmur:
  632. return models.Model.save( self, *args, **kwargs )
  633. ctl = self.server.ctl
  634. if self.owner:
  635. email = self.owner.email
  636. else:
  637. email = settings.DEFAULT_FROM_EMAIL
  638. if self.id is None:
  639. # This is a new user record, so Murmur doesn't know about it yet
  640. if len( ctl.getRegisteredPlayers( self.server.srvid, self.name ) ) > 0:
  641. raise ValueError( "Another player already registered that name." )
  642. if not self.password:
  643. raise ValueError( "Cannot register player without a password!" )
  644. self.mumbleid = ctl.registerPlayer( self.server.srvid, self.name, email, self.password )
  645. # Update user's registration
  646. elif self.password:
  647. ctl.setRegistration(
  648. self.server.srvid,
  649. self.mumbleid,
  650. self.name,
  651. email,
  652. self.password
  653. )
  654. # Don't save the users' passwords, we don't need them anyway
  655. self.password = ''
  656. # If enabled (and possible), set Gravatar as default Avatar
  657. if not self.hasTexture and settings.USE_GRAVATAR and self.gravatar:
  658. self.setTextureFromUrl( self.gravatar )
  659. return models.Model.save( self, *args, **kwargs )
  660. def __init__( self, *args, **kwargs ):
  661. models.Model.__init__( self, *args, **kwargs )
  662. self._registration = None
  663. # Admin handlers
  664. def getAdmin( self ):
  665. """ Get ACL of root Channel, get the admin group and see if this user is in it. """
  666. if self.mumbleid == -1:
  667. return False
  668. else:
  669. return self.server.rootchan.acl.group_has_member( "admin", self.mumbleid )
  670. def setAdmin( self, value ):
  671. """ Set or revoke this user's membership in the admin group on the root channel. """
  672. if self.mumbleid == -1:
  673. return False
  674. if value:
  675. self.server.rootchan.acl.group_add_member( "admin", self.mumbleid )
  676. else:
  677. self.server.rootchan.acl.group_remove_member( "admin", self.mumbleid )
  678. self.server.rootchan.acl.save()
  679. return value
  680. aclAdmin = property( getAdmin, setAdmin, doc=ugettext_noop('Admin on root channel') )
  681. # Registration fetching
  682. def getRegistration( self ):
  683. """ Retrieve a user's registration from Murmur as a dict. """
  684. if not self._registration:
  685. self._registration = self.server.ctl.getRegistration( self.server.srvid, self.mumbleid )
  686. return self._registration
  687. registration = property( getRegistration )
  688. # Texture handlers
  689. def getTexture( self ):
  690. """ Get the user texture as a PIL Image. """
  691. return self.server.getUserTexture( self.mumbleid )
  692. def setTexture( self, image ):
  693. """ Install the given image as the user's texture. """
  694. self.server.setUserTexture( self.mumbleid, image )
  695. def setTextureFromUrl( self, url, transparency=None ):
  696. """ Retrieve the image at the given URL and set it as my texture. """
  697. img = Image.open( StringIO( urlopen( url ).read() ) )
  698. self.setTexture( img )
  699. def setTextureFromGravatar( self ):
  700. return self.setTextureFromUrl( self.gravatar )
  701. texture = property( getTexture, setTexture,
  702. doc="Get the texture as a PIL Image or set the Image as the texture."
  703. )
  704. def hasTexture( self ):
  705. """ Check if this user has a texture set. """
  706. return self.server.hasUserTexture( self.mumbleid )
  707. def gravatarUrl( self, size=80 ):
  708. """ Get a Gravatar URL for my owner's email adress (if any), or using the User's cert hash.
  709. The size parameter is optional, and defaults to 80 pixels (the default used by Gravatar
  710. if you omit this parameter in the URL).
  711. """
  712. if self.owner and self.owner.email:
  713. from hashlib import md5
  714. return settings.GRAVATAR_URL % { 'hash': md5(self.owner.email).hexdigest(), 'size': size }
  715. elif self.hash:
  716. return settings.GRAVATAR_URL % { 'hash': self.hash, 'size': size }
  717. return None
  718. def getTextureUrl( self ):
  719. """ Get a URL under which the texture can be retrieved. """
  720. from views import showTexture
  721. from django.core.urlresolvers import reverse
  722. return reverse( showTexture, kwargs={ 'server': self.server.id, 'userid': self.id } )
  723. textureUrl = property( getTextureUrl )
  724. # Deletion handler
  725. @staticmethod
  726. def pre_delete_listener( **kwargs ):
  727. kwargs['instance'].unregister()
  728. def unregister( self ):
  729. """ Delete this user account from Murmur. """
  730. if self.getAdmin():
  731. self.setAdmin( False )
  732. self.server.ctl.unregisterPlayer(self.server.srvid, self.mumbleid)
  733. # "server" field protection
  734. def __setattr__( self, name, value ):
  735. if name == 'server':
  736. if self.id is not None and self.server != value:
  737. raise AttributeError( _( "This field must not be updated once the record has been saved." ) )
  738. models.Model.__setattr__( self, name, value )
  739. signals.pre_delete.connect( Mumble.pre_delete_listener, sender=Mumble )
  740. signals.pre_delete.connect( MumbleUser.pre_delete_listener, sender=MumbleUser )