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.

407 lines
15 KiB

  1. # -*- coding: utf-8 -*-
  2. # kate: space-indent on; indent-width 4; replace-tabs on;
  3. """
  4. * Copyright © 2009-2010, Michael "Svedrin" Ziegler <diese-addy@funzt-halt.net>
  5. *
  6. * Mumble-Django is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This package is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. """
  16. import socket
  17. import re
  18. from django import forms
  19. from django.conf import settings
  20. from django.forms import Form, ModelForm
  21. from django.forms.models import ModelFormMetaclass
  22. from django.utils.translation import ugettext_lazy as _
  23. from mumble.models import MumbleServer, Mumble, MumbleUser
  24. from djextdirect.formprovider import FormProvider
  25. EXT_FORMS_PROVIDER = FormProvider(name="Ext.app.MUMBLE_FORMS_API")
  26. class PropertyModelFormMeta( ModelFormMetaclass ):
  27. """ Metaclass that updates the property generated fields with the
  28. docstrings from their model counterparts.
  29. """
  30. def __init__( cls, name, bases, attrs ):
  31. ModelFormMetaclass.__init__( cls, name, bases, attrs )
  32. if cls._meta.model:
  33. model = cls._meta.model
  34. elif hasattr( bases[0], '_meta' ) and bases[0]._meta.model:
  35. # apparently, _meta has not been created yet if inherited, so use parent's (if any)
  36. model = bases[0]._meta.model
  37. else:
  38. model = None
  39. if model:
  40. mdlfields = model._meta.get_all_field_names()
  41. for fldname in cls.base_fields:
  42. if fldname in mdlfields:
  43. continue
  44. prop = getattr( model, fldname )
  45. if prop.__doc__:
  46. cls.base_fields[fldname].label = _(prop.__doc__)
  47. class PropertyModelForm( ModelForm ):
  48. """ ModelForm that gets/sets fields that are not within the model's
  49. fields as model attributes. Necessary to get forms that manipulate
  50. properties.
  51. """
  52. __metaclass__ = PropertyModelFormMeta
  53. def __init__( self, *args, **kwargs ):
  54. ModelForm.__init__( self, *args, **kwargs )
  55. if self.instance:
  56. instfields = self.instance._meta.get_all_field_names()
  57. for fldname in self.fields:
  58. if fldname in instfields:
  59. continue
  60. self.fields[fldname].initial = getattr( self.instance, fldname )
  61. def save( self, commit=True ):
  62. inst = ModelForm.save( self, commit=commit )
  63. if commit:
  64. self.save_to_model( inst )
  65. else:
  66. # Update when the model has been saved.
  67. from django.db.models import signals
  68. self._update_inst = inst
  69. signals.post_save.connect( self.save_listener, sender=inst.__class__ )
  70. return inst
  71. def save_listener( self, **kwargs ):
  72. if kwargs['instance'] is self._update_inst:
  73. self.save_to_model( self._update_inst )
  74. def save_to_model( self, inst ):
  75. instfields = inst._meta.get_all_field_names()
  76. for fldname in self.fields:
  77. if fldname not in instfields:
  78. setattr( inst, fldname, self.cleaned_data[fldname] )
  79. class MumbleForm( PropertyModelForm ):
  80. """ The Mumble Server admin form that allows to configure settings which do
  81. not necessarily have to be reserved to the server hoster.
  82. Server hosters are expected to use the Django admin application instead,
  83. where everything can be configured freely.
  84. """
  85. url = forms.CharField( required=False )
  86. motd = forms.CharField( required=False, widget=forms.Textarea )
  87. passwd = forms.CharField( required=False, help_text=_(
  88. "Password required to join. Leave empty for public servers.") )
  89. supw = forms.CharField( required=False, widget=forms.PasswordInput )
  90. player = forms.CharField( required=False )
  91. channel = forms.CharField( required=False )
  92. defchan = forms.TypedChoiceField( choices=(), coerce=int, required=False )
  93. timeout = forms.IntegerField( required=False )
  94. certreq = forms.BooleanField( required=False )
  95. textlen = forms.IntegerField( required=False )
  96. html = forms.BooleanField( required=False )
  97. rememchn= forms.BooleanField( required=False, help_text=_(
  98. "Remember the channel users were in when they quit, and automatically move them to "
  99. "that channel when they join.") )
  100. def __init__( self, *args, **kwargs ):
  101. PropertyModelForm.__init__( self, *args, **kwargs )
  102. # Populate the `default channel' field's choices
  103. choices = [ ('', '----------') ]
  104. if self.instance and self.instance.srvid is not None:
  105. if self.instance.booted:
  106. def add_item( item, level ):
  107. if item.is_server or item.is_channel:
  108. choices.append( ( item.chanid, ( "-"*level + " " + item.name ) ) )
  109. self.instance.rootchan.visit(add_item)
  110. else:
  111. current = self.instance.defchan
  112. if current is not None:
  113. choices.append( ( current, "Current value: %d" % current ) )
  114. self.fields['defchan'].choices = choices
  115. class Meta:
  116. model = Mumble
  117. fields = ['name']
  118. def EXT_authorize( self, request, action ):
  119. return self.instance.isUserAdmin( request.user )
  120. EXT_FORMS_PROVIDER.register_form( MumbleForm )
  121. class MumbleAdminForm( MumbleForm ):
  122. """ A Mumble Server admin form intended to be used by the server hoster. """
  123. users = forms.IntegerField( required=False )
  124. usersperchannel = forms.IntegerField( required=False )
  125. bwidth = forms.IntegerField( required=False )
  126. sslcrt = forms.CharField( required=False, widget=forms.Textarea )
  127. sslkey = forms.CharField( required=False, widget=forms.Textarea )
  128. booted = forms.BooleanField( required=False, initial=True )
  129. autoboot = forms.BooleanField( required=False, initial=True )
  130. bonjour = forms.BooleanField( required=False )
  131. class Meta:
  132. fields = None
  133. exclude = None
  134. def clean_port( self ):
  135. """ Check if the port number is valid. """
  136. port = self.cleaned_data['port']
  137. if port is not None and port != '':
  138. if port < 1 or port >= 2**16:
  139. raise forms.ValidationError(
  140. _("Port number %(portno)d is not within the allowed range %(minrange)d - %(maxrange)d") % {
  141. 'portno': port,
  142. 'minrange': 1,
  143. 'maxrange': 2**16,
  144. })
  145. return port
  146. return None
  147. class MumbleServerForm( ModelForm ):
  148. defaultconf = forms.CharField( label=_("Default config"), required=False, widget=forms.Textarea )
  149. def __init__( self, *args, **kwargs ):
  150. ModelForm.__init__( self, *args, **kwargs )
  151. # self.instance = instance of MumbleServer, NOT a server instance
  152. if self.instance and self.instance.id:
  153. if self.instance.online:
  154. confstr = ""
  155. conf = self.instance.defaultconf
  156. for field in conf:
  157. confstr += "%s: %s\n" % ( field, conf[field] )
  158. self.fields["defaultconf"].initial = confstr
  159. else:
  160. self.fields["defaultconf"].initial = _("This server is currently offline.")
  161. class Meta:
  162. model = MumbleServer
  163. class MumbleUserForm( ModelForm ):
  164. """ The user registration form used to register an account. """
  165. password = forms.CharField( label=_("Password"), widget=forms.PasswordInput, required=False )
  166. def __init__( self, *args, **kwargs ):
  167. ModelForm.__init__( self, *args, **kwargs )
  168. self.server = None
  169. def EXT_authorize( self, request, action ):
  170. if not request.user.is_authenticated():
  171. return False
  172. if action == "update" and settings.PROTECTED_MODE and self.instance.id is None:
  173. # creating new user in protected mode -> need UserPasswordForm
  174. return False
  175. if self.instance.id is not None and request.user != self.instance.owner:
  176. # editing another account
  177. return False
  178. return True
  179. def EXT_validate( self, request ):
  180. if "serverid" in request.POST:
  181. try:
  182. self.server = Mumble.objects.get( id=int(request.POST['serverid']) )
  183. except Mumble.DoesNotExist:
  184. return False
  185. else:
  186. return True
  187. return False
  188. def clean_name( self ):
  189. """ Check if the desired name is forbidden or taken. """
  190. name = self.cleaned_data['name']
  191. if self.server is None:
  192. raise AttributeError( "You need to set the form's server attribute to the server instance "
  193. "for validation to work." )
  194. if self.server.player and re.compile( self.server.player ).match( name ) is None:
  195. raise forms.ValidationError( _( "That name is forbidden by the server." ) )
  196. if not self.instance.id and len( self.server.ctl.getRegisteredPlayers( self.server.srvid, name ) ) > 0:
  197. raise forms.ValidationError( _( "Another player already registered that name." ) )
  198. return name
  199. def clean_password( self ):
  200. """ Verify a password has been given. """
  201. passwd = self.cleaned_data['password']
  202. if not passwd and ( not self.instance or self.instance.mumbleid == -1 ):
  203. raise forms.ValidationError( _( "Cannot register player without a password!" ) )
  204. return passwd
  205. def save(self):
  206. self.instance.server = self.server
  207. ModelForm.save(self)
  208. class Meta:
  209. model = MumbleUser
  210. fields = ( 'name', 'password' )
  211. EXT_FORMS_PROVIDER.register_form( MumbleUserForm )
  212. class MumbleUserPasswordForm( MumbleUserForm ):
  213. """ The user registration form used to register an account on a private server in protected mode. """
  214. serverpw = forms.CharField(
  215. label=_('Server Password'),
  216. help_text=_('This server is private and protected mode is active. Please enter the server password.'),
  217. widget=forms.PasswordInput(render_value=False)
  218. )
  219. def EXT_authorize( self, request, action ):
  220. if not request.user.is_authenticated():
  221. return False
  222. if self.instance.id is not None and request.user != self.instance.owner:
  223. # editing another account
  224. return False
  225. return True
  226. def clean_serverpw( self ):
  227. """ Validate the password """
  228. serverpw = self.cleaned_data['serverpw']
  229. if self.server.passwd != serverpw:
  230. raise forms.ValidationError( _( "The password you entered is incorrect." ) )
  231. return serverpw
  232. def clean( self ):
  233. """ prevent save() from trying to store the password in the Model instance. """
  234. # clean() will be called after clean_serverpw(), so it has already been validated here.
  235. if 'serverpw' in self.cleaned_data:
  236. del( self.cleaned_data['serverpw'] )
  237. return self.cleaned_data
  238. EXT_FORMS_PROVIDER.register_form( MumbleUserPasswordForm )
  239. class MumbleUserLinkForm( MumbleUserForm ):
  240. """ Special registration form to either register or link an account. """
  241. linkacc = forms.BooleanField(
  242. label=_('Link account'),
  243. help_text=_('The account already exists and belongs to me, just link it instead of creating.'),
  244. required=False,
  245. )
  246. def __init__( self, *args, **kwargs ):
  247. MumbleUserForm.__init__( self, *args, **kwargs )
  248. self.mumbleid = None
  249. def EXT_authorize( self, request, action ):
  250. if not request.user.is_authenticated() or action == "get":
  251. return False
  252. if self.instance.id is not None and request.user != self.instance.owner:
  253. # editing another account
  254. return False
  255. return settings.ALLOW_ACCOUNT_LINKING
  256. def clean_name( self ):
  257. """ Check if the target account exists in Murmur. """
  258. if 'linkacc' not in self.data:
  259. return MumbleUserForm.clean_name( self )
  260. # Check if user exists
  261. name = self.cleaned_data['name']
  262. if len( self.server.ctl.getRegisteredPlayers( self.server.srvid, name ) ) != 1:
  263. raise forms.ValidationError( _( "No such user found." ) )
  264. return name
  265. def clean_password( self ):
  266. """ Verify that the password is correct. """
  267. if 'linkacc' not in self.data:
  268. return MumbleUserForm.clean_password( self )
  269. if 'name' not in self.cleaned_data:
  270. # keep clean() from trying to find a user that CAN'T exist
  271. self.mumbleid = -10
  272. return ''
  273. # Validate password with Murmur
  274. passwd = self.cleaned_data['password']
  275. self.mumbleid = self.server.ctl.verifyPassword( self.server.srvid, self.cleaned_data['name'], passwd )
  276. if self.mumbleid <= 0:
  277. raise forms.ValidationError( _( "The password you entered is incorrect." ) )
  278. return passwd
  279. def clean( self ):
  280. """ Create the MumbleUser instance to save in. """
  281. if 'linkacc' not in self.data or self.mumbleid <= 0:
  282. return self.cleaned_data
  283. try:
  284. m_user = MumbleUser.objects.get( server=self.server, mumbleid=self.mumbleid )
  285. except MumbleUser.DoesNotExist:
  286. m_user = MumbleUser( server=self.server, name=self.cleaned_data['name'], mumbleid=self.mumbleid )
  287. m_user.save( dontConfigureMurmur=True )
  288. else:
  289. if m_user.owner is not None:
  290. raise forms.ValidationError( _( "That account belongs to someone else." ) )
  291. if m_user.getAdmin() and not settings.ALLOW_ACCOUNT_LINKING_ADMINS:
  292. raise forms.ValidationError( _( "Linking Admin accounts is not allowed." ) )
  293. self.instance = m_user
  294. return self.cleaned_data
  295. EXT_FORMS_PROVIDER.register_form( MumbleUserLinkForm )
  296. class MumbleUserAdminForm( PropertyModelForm ):
  297. aclAdmin = forms.BooleanField( required=False )
  298. password = forms.CharField( widget=forms.PasswordInput, required=False )
  299. def clean_password( self ):
  300. """ Verify a password has been given. """
  301. passwd = self.cleaned_data['password']
  302. if not passwd and ( not self.instance or self.instance.mumbleid == -1 ):
  303. raise forms.ValidationError( _( "Cannot register player without a password!" ) )
  304. return passwd
  305. class Meta:
  306. model = MumbleUser
  307. class MumbleKickForm( Form ):
  308. session = forms.IntegerField()
  309. ban = forms.BooleanField( required=False )
  310. reason = forms.CharField( required=False )
  311. class MumbleTextureForm( Form ):
  312. """ The form used to upload a new image to be set as texture. """
  313. usegravatar = forms.BooleanField( required=False, label=_("Use my Gravatar as my Texture") )
  314. texturefile = forms.ImageField( required=False, label=_("User Texture") )