0]\n # estimate the sample rate of the pre-processed data\n pp_nsamp = [m.shape[0] for m in tmpdatabuf]\n pp_ts = [ m[-1,-1] for m in tmpdatabuf]\n self.fs = np.median( np.array(pp_nsamp[1:]) / np.diff(pp_ts) * 1000.0)# fs = nSamp/time\n print('Estimated pre-processed sample rate={}'.format(self.fs))\n\n # create the ring buffer, big enough to store the pre-processed data\n if self.data_ringbuffer:\n print(\"Warning: re-init data ring buffer\")\n # TODO []: why does the datatype of the ring buffer matter so much? Is it because of uss?\n # Answer[]: it's the time-stamps, float32 rounds time-stamps to 24bits\n self.data_ringbuffer = RingBuffer(maxsize=self.fs*self.datawindow_ms/1000, shape=tmpdatabuf[0].shape[1:], dtype=np.float32)\n\n # insert the warmup data into the ring buffer\n self.data_timestamp=None # reset last seen data\n nsamp=0\n # re-init the preprocessor for consistency with off-line\n if self.data_preprocessor:\n self.data_preprocessor.fit(np.array(databuf[0].samples)[0:1,:], fs=self.raw_fs)\n # use linear trend tracker to de-jitter the sample timestamps\n if self.sample2timestamp is None or isinstance(self.sample2timestamp,str):\n self.sample2timestamp = timestamp_interpolation(fs=self.fs,\n sample2timestamp=self.sample2timestamp)\n for m in databuf:\n # apply the pre-processing again (this time with fs estimated)\n d = self.processDataPacket(m)\n self.data_ringbuffer.extend(d)\n nsamp = nsamp + d.shape[0]\n\n return (nsamp, nmsg)\n\n def initStimulusRingBuffer(self):\n '''initialize the data ring buffer, by getting some seed messages and datapackets to get the data sizes etc.'''\n # TODO []: more efficient memory use, with different dtype for 'real' data and the time-stamps?\n self.stimulus_ringbuffer = RingBuffer(maxsize=self.fs*self.datawindow_ms/1000, shape=(257,), dtype=np.float32)\n\n def preprocess_message(self, m:UtopiaMessage):\n \"\"\"[apply pre-processing to topia message before any more work]\n\n Args:\n m (UtopiaMessage): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n \n # WARNING BODGE: fit time-stamp in 24bits for float32 ring buffer\n # Note: this leads to wrap-arroung in (1<<24)/1000/3600 = 4.6 hours\n # but that shouldn't matter.....\n m.timestamp = m.timestamp % (1<<24)\n return m\n \n def processDataPacket(self, m: DataPacket):\n \"\"\"[pre-process a datapacket message ready to be inserted into the ringbuffer]\n\n Args:\n m (DataPacket): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n \n #print(\"DP: {}\".format(m))\n # extract the raw data\n d = np.array(m.samples, dtype=np.float32) # process as singles\n # apply the pre-processor, if one was given\n\n if self.data_preprocessor:\n d_raw = d.copy()\n # warning-- with agressive downsample this may not produce any data!\n d = self.data_preprocessor.transform(d)\n\n # BODGE: running estimate of the electrode-quality, ONLY after initialization!\n if self.send_signalquality and self.data_ringbuffer is not None:\n self.update_and_send_ElectrodeQualities(d_raw, d, m.timestamp)\n\n #if self.VERBOSITY > 0 and self.data_ringbuffer is not None:\n # self.plot_raw_preproc_data(d_raw,d,m.timestamp)\n\n if d.size > 0 :\n # If have data to add to the ring-buffer, guarding for time-stamp wrap-around\n # TODO [ ]: de-jitter and better timestamp interpolation\n # guard for wrap-around!\n if self.data_timestamp is not None and m.timestamp < self.data_timestamp:\n print(\"Warning: Time-stamp wrap-around detected!!\")\n\n d = self.add_sample_timestamps(d,m.timestamp,self.fs)\n\n # update the last time-stamp tracking\n self.data_timestamp= m.timestamp\n return d\n\n def add_sample_timestamps(self,d:np.ndarray,timestamp:float,fs:float):\n \"\"\"add per-sample timestamp information to the data matrix\n\n Args:\n d (np.ndarray): (t,d) the data matrix to attach time stamps to\n timestamp (float): the timestamp of the last sample of d\n fs (float): the nomional sample rate of d\n\n Returns:\n np.ndarray: (t,d+1) data matrix with attached time-stamp channel\n \"\"\"\n if self.sample2timestamp is not None and not isinstance(self.sample2timestamp,str):\n sample_ts = self.sample2timestamp.transform(timestamp, len(d))\n else: # all the same ts\n sample_ts = np.ones((len(d),),dtype=int)*timestamp\n # combine data with timestamps, ensuring type is preserved\n d = np.append(np.array(d), sample_ts[:, np.newaxis], -1).astype(d.dtype)\n return d\n\n def plot_raw_preproc_data(self, d_raw, d_preproc, ts):\n \"\"\"[debugging function to check the diff between the raw and pre-processed data]\n\n Args:\n d_raw ([type]): [description]\n d_preproc ([type]): [description]\n ts ([type]): [description]\n \"\"\" \n \n if not hasattr(self,'rawringbuffer'):\n self.preprocringbuffer=RingBuffer(maxsize=self.fs*3,shape=(d_preproc.shape[-1]+1,))\n self.rawringbuffer=RingBuffer(maxsize=self.raw_fs*3,shape=(d_raw.shape[-1]+1,))\n d_preproc = self.add_sample_timestamps(d_preproc,ts,self.fs)\n self.preprocringbuffer.extend(d_preproc)\n d_raw = self.add_sample_timestamps(d_raw,ts,self.raw_fs)\n self.rawringbuffer.extend(d_raw)\n if self.last_sigquality_ts is None or ts > self.last_sigquality_ts + self.send_sigquality_interval:\n import matplotlib.pyplot as plt\n plt.figure(10);plt.clf();\n idx = np.flatnonzero(self.rawringbuffer[:,-1])[0]\n plt.subplot(211); plt.cla(); plt.plot(self.rawringbuffer[idx:,-1],self.rawringbuffer[idx:,:-1])\n idx = np.flatnonzero(self.preprocringbuffer[:,-1])[0]\n plt.subplot(212); plt.cla(); plt.plot(self.preprocringbuffer[idx:,-1],self.preprocringbuffer[idx:,:-1])\n plt.show(block=False)\n\n\n def processStimulusEvent(self, m: StimulusEvent):\n \"\"\"[pre-process a StimulusEvent message ready to be inserted into the stimulus ringbuffer]\n\n Args:\n m (StimulusEvent): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n \n # get the vector to hold the stimulus info\n d = np.zeros((257,),dtype=np.float32)\n\n if self.stimulus_ringbuffer is not None and self.stimulus_timestamp is not None:\n # hold value of used objIDs from previous time stamp\n d[:] = self.stimulus_ringbuffer[-1,:]\n\n # insert the updated state\n d[m.objIDs] = m.objState\n d[-1] = m.timestamp\n # apply the pre-processor, if one was given\n if self.stimulus_preprocessor:\n d = self.stimulus_preprocessor.transform(d)\n\n # update the last time-stamp tracking\n self.stimulus_timestamp= m.timestamp\n return d\n\n def update_and_send_ElectrodeQualities(self, d_raw: np.ndarray, d_preproc: np.ndarray, ts: int):\n \"\"\"[compute running estimate of electrode qality and stream it]\n\n Args:\n d_raw (np.ndarray): [description]\n d_preproc (np.ndarray): [description]\n ts (int): [description]\n \"\"\" \n \n raw_power, preproc_power = self.update_electrode_powers(d_raw, d_preproc)\n\n # convert to average amplitude\n raw_amp = np.sqrt(raw_power)\n preproc_amp = np.sqrt(preproc_power)\n\n # noise2signal estimated as removed raw amplitude (assumed=noise) to preprocessed amplitude (assumed=signal)\n noise2sig = np.maximum(float(1e-6), np.abs(raw_amp - preproc_amp)) / np.maximum(float(1e-8),preproc_amp)\n\n # hack - detect disconnected channels\n noise2sig[ raw_power < 1e-6 ] = 100\n\n # hack - detect filter artifacts = preproc power is too big..\n noise2sig[ preproc_amp > raw_amp*10 ] = 100\n\n # hack - cap to 100\n noise2sig = np.minimum(noise2sig,100)\n\n # rate limit sending of signal-quality messages\n if self.last_sigquality_ts is None or ts > self.last_sigquality_ts + self.send_sigquality_interval:\n print(\"SigQ:\\nraw_power=({}/{})\\npp_power=({}/{})\\nnoise2sig={}\".format(\n raw_amp,d_raw.shape[0],\n preproc_amp,d_preproc.shape[0],\n noise2sig))\n print(\"Q\",end='')\n # N.B. use *our* time-stamp for outgoing messages!\n self.sendMessage(SignalQuality(None, noise2sig))\n self.last_sigquality_ts = ts\n\n if self.VERBOSITY>2:\n # plot the sample time-stamp jitter...\n import matplotlib.pyplot as plt\n plt.figure(10)\n ts = self.data_ringbuffer[:,-1]\n idx = np.flatnonzero(ts)\n if len(idx)>0:\n ts = ts[idx[0]:]\n plt.subplot(211); plt.cla(); plt.plot(np.diff(ts)); plt.title('diff time-sample')\n plt.subplot(212); plt.cla(); plt.plot((ts-ts[0])-np.arange(len(ts))*1000.0/self.fs); plt.title('regression against sample-number')\n plt.show(block=False)\n\n def update_electrode_powers(self, d_raw: np.ndarray, d_preproc:np.ndarray):\n \"\"\"[track exp-weighted-moving average centered power for 2 input streams]\n\n Args:\n d_raw (np.ndarray): [description]\n d_preproc (np.ndarray): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n \n if self.raw_power is None:\n mu_hl, pow_hl = self.noise2sig_halflife_ms\n self.raw_power = power_tracker(mu_hl, pow_hl, self.raw_fs)\n self.preproc_power = power_tracker(mu_hl, pow_hl, self.fs)\n self.raw_power.transform(d_raw)\n self.preproc_power.transform(d_preproc)\n return (self.raw_power.power(), self.preproc_power.power())\n\n\n def update(self, timeout_ms=None, mintime_ms=None):\n '''Update the tracking state w.r.t. the data source\n\n By adding data to the data_ringbuffer, stimulus info to the stimulus_ringbuffer, \n and other messages to the messages ring buffer.\n\n Args\n timeout_ms : int\n max block waiting for messages before returning\n mintime_ms : int\n min time to accumulate messages before returning\n Returns\n newmsgs : [newMsgs :UtopiaMessage]\n list of the *new* utopia messages from the server\n nsamp: int\n number of new data samples in this call\n Note: use data_ringbuffer[-nsamp:,...] to get the new data\n nstimulus : int\n number of new stimulus events in this call\n Note: use stimulus_ringbuffer[-nstimulus:,...] to get the new data\n '''\n if timeout_ms is None:\n timeout_ms = self.timeout_ms\n if mintime_ms is None:\n mintime_ms = self.mintime_ms\n if not self.isConnected():\n self.connect()\n if not self.isConnected():\n return [],0,0\n\n t0 = self.getTimeStamp()\n nsamp = 0\n nmsg = 0\n nstimulus = 0\n\n if self.data_ringbuffer is None: # do special init stuff if not done\n nsamp, nmsg = self.initDataRingBuffer()\n if self.stimulus_ringbuffer is None: # do special init stuff if not done\n self.initStimulusRingBuffer()\n if self.last_log_ts is None:\n self.last_log_ts = self.getTimeStamp()\n if t0 is None:\n t0 = self.getTimeStamp()\n\n # record the list of new messages from this call\n newmsgs = self.newmsgs # start with any left-overs from old calls \n self.newmsgs=[] # clear the left-over messages stack\n \n ttg = timeout_ms - (self.getTimeStamp() - t0) # time-to-go in the update loop\n while ttg > 0:\n\n # rate limit\n if ttg >= mintime_ms:\n sleep(mintime_ms/1000.0)\n ttg = timeout_ms - (self.getTimeStamp() - t0) # udate time-to-go\n \n # get the new messages\n msgs = self.getNewMessages(ttg)\n\n # process the messages - basically to split datapackets from the rest\n print(\".\",end='')\n #print(\"{} in {}\".format(len(msgs),self.getTimeStamp()-t0),end='',flush=True)\n for m in msgs:\n m = self.preprocess_message(m)\n \n print(\"{:c}\".format(m.msgID), end='', flush=True)\n \n if m.msgID == DataPacket.msgID: # data-packets are special\n d = self.processDataPacket(m) # (samp x ...)\n self.data_ringbuffer.extend(d)\n nsamp = nsamp + d.shape[0]\n \n elif m.msgID == StimulusEvent.msgID: # as are stmiuluse events\n d = self.processStimulusEvent(m) # (nY x ...)\n self.stimulus_ringbuffer.append(d)\n nstimulus = nstimulus + 1\n \n else:\n # NewTarget/Selection are also special in that they clear stimulus state...\n if m.msgID == NewTarget.msgID or m.msgID == Selection.msgID :\n # Make a dummy stim-event to reset all objIDs to off\n d = self.processStimulusEvent(StimulusEvent(m.timestamp,\n np.arange(255,dtype=np.int32),\n np.zeros(255,dtype=np.int8)))\n self.stimulus_ringbuffer.append(d)\n self.stimulus_timestamp= m.timestamp\n \n if len(self.msg_ringbuffer)>0 and m.timestamp > self.msg_ringbuffer[0].timestamp + self.msgwindow_ms: # slide msg buffer\n self.msg_ringbuffer.popleft()\n self.msg_ringbuffer.append(m)\n newmsgs.append(m)\n nmsg = nmsg+1\n self.msg_timestamp = m.timestamp\n \n # update time-to-go\n ttg = timeout_ms - (self.getTimeStamp() - t0)\n\n # new line\n if self.getTimeStamp() > self.last_log_ts + 2000:\n print(\"\",flush=True)\n self.last_log_ts = self.getTimeStamp()\n \n # return new messages, and count new samples/stimulus \n return (newmsgs, nsamp, nstimulus)\n\n\n\n def push_back_newmsgs(self,oldmsgs):\n \"\"\"[put unprocessed messages back onto the newmessages queue]\n\n Args:\n oldmsgs ([type]): [description]\n \"\"\" \n \n # TODO []: ensure this preserves message time-stamp order?\n self.newmsgs.extend(oldmsgs)\n\n\n\n\n def extract_data_segment(self, bgn_ts, end_ts=None):\n \"\"\"extract a segment of data based on a start and end time-stamp\n\n Args:\n bgn_ts (float): segment start time-stamp\n end_ts (float, optional): segment end time-stamp. Defaults to None.\n\n Returns:\n (np.ndarray): the data between these time-stamps, or None if timestamps invalid\n \"\"\" \n return extract_ringbuffer_segment(self.data_ringbuffer,bgn_ts,end_ts)\n \n def extract_stimulus_segment(self, bgn_ts, end_ts=None):\n \"\"\"extract a segment of the stimulus stream based on a start and end time-stamp\n\n Args:\n bgn_ts (float): segment start time-stamp\n end_ts (float, optional): segment end time-stamp. Defaults to None.\n\n Returns:\n (np.ndarray): the stimulus events between these time-stamps, or None if timestamps invalid\n \"\"\" \n return extract_ringbuffer_segment(self.stimulus_ringbuffer,bgn_ts,end_ts)\n \n def extract_msgs_segment(self, bgn_ts, end_ts=None):\n \"\"\"[extract the messages between start/end time stamps]\n\n Args:\n bgn_ts ([type]): [description]\n end_ts ([type], optional): [description]. Defaults to None.\n\n Returns:\n [type]: [description]\n \"\"\" \n \n msgs = [] # store the trial stimEvents\n for m in reversed(self.msg_ringbuffer):\n if m.timestamp <= bgn_ts:\n # stop as soon as earlier than bgn_ts\n break\n if end_ts is None or m.timestamp < end_ts:\n msgs.append(m)\n # reverse back to input order\n msgs.reverse()\n return msgs\n\n def run(self, timeout_ms=30000):\n \"\"\"[test run the interface forever, just getting and storing data]\n\n Args:\n timeout_ms (int, optional): [description]. Defaults to 30000.\n \"\"\" \n \n t0 = self.getTimeStamp()\n # test getting 5s data\n tstart = self.data_timestamp\n trlen_ms = 5000\n while self.getTimeStamp() < t0+timeout_ms:\n self.update()\n # test getting a data segment\n if tstart is None :\n tstart = self.data_timestamp\n if tstart and self.data_timestamp > tstart + trlen_ms:\n X = self.extract_data_segment(tstart, tstart+trlen_ms)\n print(\"Got data: {}->{}\\n{}\".format(tstart, tstart+trlen_ms, X[:, -1]))\n Y = self.extract_stimulus_segment(tstart, tstart+trlen_ms)\n print(\"Got stimulus: {}->{}\\n{}\".format(tstart, tstart+trlen_ms, Y[:, -1]))\n tstart = self.data_timestamp + 5000\n print('.', flush=True)\n\n\ntry:\n from sklearn.base import TransformerMixin\nexcept:\n # fake the class if sklearn is not available, e.g. Android/iOS\n class TransformerMixin:\n def __init__():\n pass\n def fit(self,X):\n pass\n def transform(self,X):\n pass\n\n\n\n\n\n\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\nfrom mindaffectBCI.decoder.utils import sosfilt, butter_sosfilt, sosfilt_zi_warmup\nclass butterfilt_and_downsample(TransformerMixin):\n \"\"\"Incremental streaming transformer to provide filtering and downsampling data transformations\n\n Args:\n TransformerMixin ([type]): sklearn compatible transformer\n \"\"\" \n def __init__(self, stopband=((0,5),(5,-1)), order:int=6, fs:float =250, fs_out:float =60, ftype='butter'):\n self.stopband = stopband\n self.fs = fs\n self.fs_out = fs_out if fs_out is not None and fs_out < fs else fs\n self.order = order\n self.axis = -2\n if not self.axis == -2:\n raise ValueError(\"axis != -2 is not yet supported!\")\n self.nsamp = 0\n self.ftype = ftype\n\n def fit(self, X, fs:float =None, zi=None):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n fs (float, optional): [description]. Defaults to None.\n zi ([type], optional): [description]. Defaults to None.\n\n Returns:\n [type]: [description]\n \"\"\" \n if fs is not None: # parameter overrides stored fs\n self.fs = fs\n\n # preprocess -> spectral filter\n if isinstance(self.stopband, str):\n import pickle\n import os\n # load coefficients from file -- when scipy isn't available\n if os.path.isfile(self.stopband):\n fn = self.stopband \n else: # try relative to our py file\n fn = os.path.join(os.path.dirname(os.path.abspath(__file__)),self.stopband)\n with open(fn,'rb') as f:\n self.sos_ = pickle.load(f)\n self.zi_ = pickle.load(f)\n f.close()\n # tweak the shape/scale of zi to the actual data shape\n self.zi_ = sosfilt_zi_warmup(self.zi_, X, self.axis)\n print(\"X={} zi={}\".format(X.shape,self.zi_.shape))\n\n else:\n # estimate them from the given information\n X, self.sos_, self.zi_ = butter_sosfilt(X, self.stopband, self.fs, order=self.order, axis=self.axis, zi=zi, ftype=self.ftype)\n \n # preprocess -> downsample\n self.nsamp = 0\n self.resamprate_ = int(round(self.fs*2.0/self.fs_out))/2.0 if self.fs_out is not None else 1\n self.out_fs_ = self.fs/self.resamprate_\n print(\"resample: {}->{}hz rsrate={}\".format(self.fs, self.out_fs_, self.resamprate_))\n\n return self\n\n def transform(self, X, Y=None):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n Y ([type], optional): [description]. Defaults to None.\n\n Returns:\n [type]: [description]\n \"\"\" \n # propogate the filter coefficients between calls\n if not hasattr(self,'sos_'):\n self.fit(X[0:1,:])\n\n if self.sos_ is not None:\n X, self.zi_ = sosfilt(self.sos_, X, axis=self.axis, zi=self.zi_)\n\n nsamp = self.nsamp\n self.nsamp = self.nsamp + X.shape[self.axis] # track *raw* sample counter\n\n # preprocess -> downsample @60hz\n if self.resamprate_ > 1:\n # number samples through this cycle due to remainder of last block\n resamp_start = nsamp%self.resamprate_\n # convert to number samples needed to complete this cycle\n # this is then the sample to take for the next cycle\n if resamp_start > 0:\n resamp_start = self.resamprate_ - resamp_start\n \n # allow non-integer resample rates\n idx = np.arange(resamp_start,X.shape[self.axis],self.resamprate_)\n\n if self.resamprate_%1 > 0 and idx.size>0 : # non-integer re-sample, interpolate\n idx_l = np.floor(idx).astype(int) # sample above\n idx_u = np.ceil(idx).astype(int) # sample below\n # BODGE: guard for packet ending at sample boundary.\n idx_u[-1] = idx_u[-1] if idx_u[-1]<X.shape[self.axis] else X.shape[self.axis]-1\n w_u = idx - idx_l # linear weight of the upper sample\n X = X[...,idx_u,:] * w_u[:,np.newaxis] + X[...,idx_l,:] * (1-w_u[:,np.newaxis]) # linear interpolation\n if Y is not None:\n Y = Y[...,idx_u,:] * w_u[:,np.newaxis] + Y[...,idx_l,:] * (1-w_u[:,np.newaxis])\n\n else:\n idx = idx.astype(int)\n X = X[..., idx, :] # decimate X (trl, samp, d)\n if Y is not None:\n Y = Y[..., idx, :] # decimate Y (trl, samp, y)\n \n return X if Y is None else (X, Y)\n\n @staticmethod\n def testcase():\n ''' test the filt+downsample transformation filter by incremental calling '''\n #X=np.cumsum(np.random.randn(100,1),axis=0)\n X=np.sin(np.arange(100)[:,np.newaxis]*2*np.pi/30)\n xs = np.arange(X.shape[0])[:,np.newaxis]\n # high-pass and decimate\n bands = ((0,20,'bandpass'))\n fs = 200\n fs_out = 130\n fds = butterfilt_and_downsample(stopband=bands,fs=fs,fs_out=fs_out)\n\n \n print(\"single step\")\n fds.fit(X[0:1,:])\n m0,xs0 = fds.transform(X,xs) # (samp,ny,ne)\n print(\"M0 -> {}\".format(m0[:20]))\n\n step=6\n print(\"Step size = {}\".format(step))\n fds.fit(X[0:1,:])\n m1=np.zeros(m0.shape,m0.dtype)\n xs1 = np.zeros(xs0.shape,xs0.dtype)\n t=0\n for i in range(0,len(X),step):\n idx=np.arange(i,min(i+step,len(X)))\n mm, idx1=fds.transform(X[idx,:],idx[:,np.newaxis])\n m1[t:t+mm.shape[0],:]=mm\n xs1[t:t+mm.shape[0]]=idx1\n t = t +mm.shape[0]\n print(\"M1 -> {}\".format(m1[:20]))\n print(\"diff: {}\".format(np.max(np.abs(m0-m1))))\n\n import matplotlib.pyplot as plt \n plt.plot(xs,X,'*-',label='X')\n plt.plot(xs0,m0,'*-',label='{} {}->{}Hz single'.format(bands,fs,fs_out))\n plt.plot(xs1,m1,'*-',label='{} {}->{}Hz incremental'.format(bands,fs,fs_out))\n plt.legend()\n plt.show()\n\n\n\n\n\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\nfrom mindaffectBCI.decoder.stim2event import stim2event\nclass stim2eventfilt(TransformerMixin):\n ''' Incremental streaming transformer to transform a sequence of stimulus states to a brain event sequence\n \n For example by transforming a sequence of stimulus intensities, to rising and falling edge events.\n '''\n def __init__(self, evtlabs=None, histlen=20):\n self.evtlabs = evtlabs\n self.histlen = histlen\n self.prevX = None\n\n def fit(self, X):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n return self\n\n def transform(self, X):\n \"\"\"[transform Stimulus-encoded to brain-encoded]\n\n Args:\n X ([type]): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n \n if X is None:\n return None\n \n # keep old fitler state for the later transformation call\n prevX = self.prevX\n\n # grab the new filter state (if wanted)\n if self.histlen>0:\n #print('prevX={}'.format(prevX))\n #print(\"X={}\".format(X))\n if X.shape[0] >= self.histlen or prevX is None:\n self.prevX = X\n else:\n self.prevX = np.append(prevX, X, 0)\n # only keep the last bit -- copy in case gets changed in-place\n self.prevX = self.prevX[-self.histlen:,:].copy()\n #print('new_prevX={}'.format(self.prevX))\n\n # convert from stimulus coding to brain response coding, with old state\n X = stim2event(X, self.evtlabs, axis=-2, oM=prevX)\n return X\n\n def testcase():\n ''' test the stimulus transformation filter by incremental calling '''\n M=np.array([0,0,0,1,0,0,1,1,0,1])[:,np.newaxis] # samp,nY\n s2ef = stim2eventfilt(evtlabs=('re','fe'),histlen=3)\n\n print(\"single step\")\n m0=s2ef.transform(M) # (samp,ny,ne)\n print(\"{} -> {}\".format(M,m0))\n\n print(\"Step size = 1\")\n m1=np.zeros(m0.shape,m0.dtype)\n for i in range(len(M)):\n idx=slice(i,i+1)\n mm=s2ef.transform(M[idx,:])\n m1[idx,...]=mm\n print(\"{} {} -> {}\".format(i,M[idx,...],mm))\n\n print(\"Step size=4\")\n m4=np.zeros(m0.shape,m0.dtype)\n for i in range(0,len(M),4):\n idx=slice(i,i+4)\n mm=s2ef.transform(M[idx,:])\n m4[idx,...]=mm\n print(\"{} {} -> {}\".format(i,M[idx,...],mm))\n\n print(\"m0={}\\nm1={}\\n,m4={}\\n\".format(m0,m1,m4))\n \n\n\n\n\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\nclass power_tracker(TransformerMixin):\n \"\"\"Incremental streaming transformer from raw n-channel data, to exponientially smoothed channel powers\n\n Args:\n TransformerMixin ([type]): sklearn compatiable transformer\n \"\"\"\n\n def __init__(self,halflife_mu_ms, halflife_power_ms, fs, car=True):\n # convert to per-sample decay factor\n self.alpha_mu = self.hl2alpha(fs * halflife_mu_ms / 1000.0 ) \n self.alpha_power= self.hl2alpha(fs * halflife_power_ms / 1000.0 )\n self.car = car\n self.sX_N = None\n self.sX = None\n self.sXX_N = None\n self.sXX = None\n\n def hl2alpha(self,hl):\n \"\"\"[summary]\n\n Args:\n hl ([type]): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n return np.exp(np.log(.5)/hl)\n\n def fit(self,X):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n self.sX_N = X.shape[0]\n if self.car and X.shape[-1]>4:\n X = X.copy() - np.mean(X,-1,keepdims=True)\n self.sX = np.sum(X,axis=0)\n self.sXX_N = X.shape[0]\n self.sXX = np.sum((X-(self.sX/self.sX_N))**2,axis=0)\n return self.power()\n\n def transform(self, X: np.ndarray):\n \"\"\"[compute the exponientially weighted centered power of X]\n\n Args:\n X (np.ndarray): [description]\n\n Returns:\n [type]: [description]\n \"\"\" \n \n if self.sX is None: # not fitted yet!\n return self.fit(X)\n if self.car and X.shape[-1]>4:\n ch_power = self.power()\n # identify the active channels, i.e. are attached and have some signal\n act_ch = ch_power > np.max(ch_power)*1e-3\n X = X.copy() - np.mean(X[...,act_ch], -1, keepdims=True)\n # compute updated mean\n alpha_mu = self.alpha_mu ** X.shape[0]\n self.sX_N = self.sX_N*alpha_mu + X.shape[0]\n self.sX = self.sX*alpha_mu + np.sum(X, axis=0)\n # center and compute updated power\n alpha_pow = self.alpha_power ** X.shape[0]\n self.sXX_N = self.sXX_N*alpha_pow + X.shape[0]\n self.sXX = self.sXX*alpha_pow + np.sum((X-(self.sX/self.sX_N))**2, axis=0) \n return self.power()\n \n def mean(self):\n \"\"\"[summary]\n\n Returns:\n [type]: [description]\n \"\"\" \n return self.sX / self.sX_N\n def power(self):\n \"\"\"[summary]\n\n Returns:\n [type]: [description]\n \"\"\" \n return self.sXX / self.sXX_N\n \n def testcase(self):\n \"\"\"[summary]\n \"\"\" \n import matplotlib.pyplot as plt\n X = np.random.randn(10000,2)\n #X = np.cumsum(X,axis=0)\n pt = power_tracker(100,100,100)\n print(\"All at once: power={}\".format(pt.transform(X))) # all at once\n pt = power_tracker(100,1000,1000)\n print(\"alpha_mu={} alpha_pow={}\".format(pt.alpha_mu,pt.alpha_power) )\n step = 30\n idxs = list(range(step,X.shape[0],step))\n powers = np.zeros((len(idxs),X.shape[-1]))\n mus = np.zeros((len(idxs),X.shape[-1]))\n for i,j in enumerate(idxs):\n powers[i,:] = np.sqrt(pt.transform(X[j-step:j,:]))\n mus[i,:]=pt.mean()\n for d in range(X.shape[-1]):\n plt.subplot(X.shape[-1],1,d+1)\n plt.plot(X[:,d])\n plt.plot(idxs,mus[:,d])\n plt.plot(idxs,powers[:,d])\n\n\n\n\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\nclass timestamp_interpolation(TransformerMixin):\n \"\"\"Incremental streaming tranformer to transform from per-packet time-stamps to per-sample timestamps \n with time-stamp smoothing, de-jittering, and dropped-sample detection.\n \"\"\"\n\n def __init__(self,fs=None,sample2timestamp=None, max_delta=200):\n \"\"\"tranform from per-packet (i.e. multiple-samples) to per-sample timestamps\n\n Args:\n fs (float): default sample rate, used when no other timing info is available\n sample2timestamp (transformer, optional): class to de-jitter timestamps based on sample-count. Defaults to None.\n \"\"\" \n self.fs=fs\n a0 = 1000/self.fs if self.fs is not None else 1\n # BODGE: special cases for particular mapping functions so can include the prior slope\n if sample2timestamp=='lower_bound_tracker':\n self.sample2timestamp = lower_bound_tracker(a0=a0)\n elif sample2timestamp=='linear_trend_tracker':\n self.sample2timestamp = linear_trend_tracker(a0=a0)\n else:\n self.sample2timestamp = sample2timestamp\n self.max_delta = max_delta\n\n def fit(self,ts,nsamp=1):\n \"\"\"[summary]\n\n Args:\n ts ([type]): [description]\n nsamp (int, optional): [description]. Defaults to 1.\n \"\"\" \n self.last_sample_timestamp_ = ts\n self.n_ = 0\n\n def transform(self,timestamp:float,nsamp:int=1):\n \"\"\"add per-sample timestamp information to the data matrix\n\n Args:\n timestamp (float): the timestamp of the last sample of d\n nsamp(int): number of samples to interpolate\n\n Returns:\n np.ndarray: (nsamp) the interpolated time-stamps\n \"\"\"\n if not hasattr(self,'last_sample_timestamp_'):\n self.fit(timestamp,nsamp)\n\n # update tracking number samples processed\n self.n_ = self.n_ + nsamp\n\n if self.last_sample_timestamp_ < timestamp or self.sample2timestamp is not None:\n # update the tracker for the sample-number to sample timestamp mapping\n if self.sample2timestamp is not None:\n #print(\"n={} ts={}\".format(n,timestamp))\n newtimestamp = self.sample2timestamp.transform(self.n_, timestamp)\n #print(\"ts={} newts={} diff={}\".format(timestamp,newtimestamp,timestamp-newtimestamp))\n # use the corrected de-jittered time-stamp -- if it's not tooo different\n if abs(timestamp-newtimestamp) < self.max_delta:\n timestamp = int(newtimestamp)\n\n # simple linear interpolation for the sample time-stamps\n samples_ts = np.linspace(self.last_sample_timestamp_, timestamp, nsamp+1, endpoint=True, dtype=int)\n samples_ts = samples_ts[1:]\n else:\n if self.fs :\n # interpolate with the estimated sample rate \n samples_ts = np.arange(-nsamp+1,1,dtype=int)*(1000/self.fs) + timestamp\n else:\n # give all same timestamp\n samples_ts = np.ones(nsamp,dtype=int)*timestamp\n\n # update the tracking info\n self.last_sample_timestamp_ = timestamp\n\n return samples_ts\n\n def testcase(self, npkt=1000, fs=100):\n \"\"\"[summary]\n\n Args:\n npkt (int, optional): [description]. Defaults to 1000.\n fs (int, optional): [description]. Defaults to 100.\n \"\"\" \n # generate random packet sizes\n nsamp = np.random.random_integers(0,10,size=(npkt,))\n # generate true sample timestamps\n ts_true = np.arange(np.sum(nsamp))*1000/fs\n # packet end indices\n idx = np.cumsum(nsamp)-1\n # packet end time-stamps\n pkt_ts = ts_true[idx]\n # add some time-stamp jitter, always positive..\n pkt_ts = pkt_ts + np.random.uniform(0,.5*1000/fs,size=pkt_ts.shape)\n # apply the time-stamp interplotation\n sts=[]\n tsfn = timestamp_interpolation(fs=fs,sample2timestamp = 'lower_bound_tracker')\n for i,(n,t) in enumerate(zip(nsamp,pkt_ts)):\n samp_ts = tsfn.transform(t,n)\n sts.extend(samp_ts)\n # plot the result.\n import matplotlib.pyplot as plt\n plt.plot(ts_true - sts)\n plt.show()\n\n\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\nfrom mindaffectBCI.decoder.preprocess import temporally_decorrelate\nclass temporal_decorrelator(TransformerMixin):\n \"\"\"Incremental streaming tranformer to decorrelate temporally channels in an input stream\n \"\"\"\n\n def __init__(self, order=10, reg=1e-4, eta=1e-5, axis=-2):\n self.reg=reg\n self.eta=eta\n self.axis=axis\n\n def fit(self,X):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n \"\"\" \n self.W_ = np.zeros((self.order,X.shape[-1]),dtype=X.dtype)\n self.W_[-1,:]=1\n _, self.W_ = self.transform(X[1:,:])\n\n def transform(self,X):\n \"\"\"add per-sample timestamp information to the data matrix\n\n Args:\n X (float): the data to decorrelate\n nsamp(int): number of samples to interpolate\n\n Returns:\n np.ndarray: the decorrelated data\n \"\"\"\n if not hasattr(self,'W_'):\n self.fit(X)\n\n X, self.W_ = temporally_decorrelate(X, W=self.W_, reg=self.reg, eta=self.eta, axis=self.axis)\n\n return X\n\n def testcase(self, dur=3, fs=100, blksize=10):\n \"\"\"[summary]\n\n Args:\n dur (int, optional): [description]. Defaults to 3.\n fs (int, optional): [description]. Defaults to 100.\n blksize (int, optional): [description]. Defaults to 10.\n \"\"\" \n import numpy as np\n import matplotlib.pyplot as plt\n from mindaffectBCI.decoder.preprocess import plot_grand_average_spectrum\n fs=100\n X = np.random.standard_normal((2,fs*dur,2)) # flat spectrum\n #X = X + np.sin(np.arange(X.shape[-2])*2*np.pi/10)[:,np.newaxis]\n X = X[:,:-1,:]+X[:,1:,:] # weak low-pass\n\n #X = np.cumsum(X,-2) # 1/f spectrum\n print(\"X={}\".format(X.shape))\n plt.figure(1)\n plot_grand_average_spectrum(X, fs)\n plt.suptitle('Raw')\n plt.show(block=False)\n\n tdc = temporal_decorrelator()\n wX = np.zeros(X.shape,X.dtype)\n for i in range(0,X.shape[-1],blksize):\n idx = range(i,i+blksize)\n wX[idx,:] = tdc.transform(X[idx,:])\n \n # compare raw vs summed filterbank\n plt.figure(2)\n plot_grand_average_spectrum(wX,fs)\n plt.suptitle('Decorrelated')\n plt.show()\n\n\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\n#--------------------------------------------------------------------------\nfrom mindaffectBCI.decoder.preprocess import standardize_channel_power\nclass channel_power_standardizer(TransformerMixin):\n \"\"\"Incremental streaming tranformer to channel power normalization in an input stream\n \"\"\"\n\n def __init__(self, reg=1e-4, axis=-2):\n self.reg=reg\n self.axis=axis\n\n def fit(self,X):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n \"\"\" \n self.sigma2_ = np.zeros((X.shape[-1],), dtype=X.dtype)\n self.sigma2_ = X[0,:]*X[0,:] # warmup with 1st sample power\n self.transform(X[1:,:])\n\n def transform(self,X):\n \"\"\"add per-sample timestamp information to the data matrix\n\n Args:\n X (float): the data to decorrelate\n\n Returns:\n np.ndarray: the decorrelated data\n \"\"\"\n if not hasattr(self,'sigma2_'):\n self.fit(X)\n\n X, self.W_ = standardize_channel_power(X, sigma2=self.sigma2_, reg=self.reg, axis=self.axis)\n\n return X\n\n def testcase(self, dur=3, fs=100, blksize=10):\n \"\"\"[summary]\n\n Args:\n dur (int, optional): [description]. Defaults to 3.\n fs (int, optional): [description]. Defaults to 100.\n blksize (int, optional): [description]. Defaults to 10.\n \"\"\" \n import numpy as np\n import matplotlib.pyplot as plt\n from mindaffectBCI.decoder.preprocess import plot_grand_average_spectrum\n fs=100\n X = np.random.standard_normal((2,fs*dur,2)) # flat spectrum\n #X = X + np.sin(np.arange(X.shape[-2])*2*np.pi/10)[:,np.newaxis]\n X = X[:,:-1,:]+X[:,1:,:] # weak low-pass\n\n #X = np.cumsum(X,-2) # 1/f spectrum\n print(\"X={}\".format(X.shape))\n plt.figure(1)\n plot_grand_average_spectrum(X, fs)\n plt.suptitle('Raw')\n plt.show(block=False)\n\n cps = channel_power_standardizer()\n wX = np.zeros(X.shape,X.dtype)\n for i in range(0,X.shape[-1],blksize):\n idx = range(i,i+blksize)\n wX[idx,:] = cps.transform(X[idx,:])\n \n # compare raw vs summed filterbank\n plt.figure(2)\n plot_grand_average_spectrum(wX,fs)\n plt.suptitle('Decorrelated')\n plt.show()\n\n\ndef testRaw():\n \"\"\"[summary]\n \"\"\" \n # test with raw\n ui = UtopiaDataInterface()\n ui.connect()\n sigViewer(ui,30000) # 30s sigviewer\n\ndef testPP():\n \"\"\"[summary]\n \"\"\" \n from sigViewer import sigViewer\n # test with a filter + downsampler\n ppfn= butterfilt_and_downsample(order=4, stopband=((0,1),(25,-1)), fs_out=100)\n #ppfn= butterfilt_and_downsample(order=4, stopband='butter_stopband((0, 5), (25, -1))_fs200.pk', fs_out=80) \n ui = UtopiaDataInterface(data_preprocessor=ppfn, stimulus_preprocessor=None)\n ui.connect()\n sigViewer(ui)\n\ndef testFileProxy(filename,fs_out=999):\n \"\"\"[summary]\n\n Args:\n filename ([type]): [description]\n fs_out (int, optional): [description]. Defaults to 999.\n \"\"\" \n from mindaffectBCI.decoder.FileProxyHub import FileProxyHub\n U = FileProxyHub(filename)\n from sigViewer import sigViewer\n # test with a filter + downsampler\n #ppfn= butterfilt_and_downsample(order=4, stopband=((0,3),(25,-1)), fs_out=fs_out)\n ppfn= butterfilt_and_downsample(order=4, stopband=(1,15,'bandpass'), fs_out=fs_out)\n #ppfn = None\n ui = UtopiaDataInterface(data_preprocessor=ppfn, stimulus_preprocessor=None, mintime_ms=0, U=U)\n ui.connect()\n sigViewer(ui)\n\ndef testFileProxy2(filename):\n \"\"\"[summary]\n\n Args:\n filename ([type]): [description]\n \"\"\" \n from mindaffectBCI.decoder.FileProxyHub import FileProxyHub\n U = FileProxyHub(filename)\n fs = 200\n fs_out = 200\n # test with a filter + downsampler\n ppfn= butterfilt_and_downsample(order=4, stopband=((45,65),(0,3),(25,-1)), fs=fs, fs_out=fs_out)\n ui = UtopiaDataInterface(data_preprocessor=ppfn, stimulus_preprocessor=None, mintime_ms=0, U=U, fs=fs)\n ui.connect()\n # run in bits..\n data=[]\n stim=[]\n emptycount = 0 \n while True:\n newmsg, nsamp, nstim = ui.update()\n if len(newmsg) == 0 and nsamp == 0 and nstim == 0: \n emptycount = emptycount + 1\n if emptycount > 10:\n break\n else:\n emptycount=0\n if nsamp > 0:\n data.append(ui.data_ringbuffer[-nsamp:,:].copy())\n if nstim > 0:\n stim.append(ui.stimulus_ringbuffer[-nstim:,:].copy())\n # convert to single data block\n data = np.vstack(data)\n stim = np.vstack(stim)\n # dump as pickle\n import pickle\n if ppfn is None:\n pickle.dump(dict(data=data,stim=stim),open('raw_udi.pk','wb'))\n else:\n pickle.dump(dict(data=data,stim=stim),open('pp_udi.pk','wb'))\n\ndef testERP():\n \"\"\"[summary]\n \"\"\" \n ui = UtopiaDataInterface()\n ui.connect()\n erpViewer(ui,evtlabs=None) # 30s sigviewer\n\ndef testElectrodeQualities(X,fs=200,pktsize=20):\n \"\"\"[summary]\n\n Args:\n X ([type]): [description]\n fs (int, optional): [description]. Defaults to 200.\n pktsize (int, optional): [description]. Defaults to 20.\n\n Returns:\n [type]: [description]\n \"\"\" \n # recurse if more dims than we want...\n if X.ndim>2:\n sigq=[]\n for i in range(X.shape[0]):\n sigqi = testElectrodeQualities(X[i,...],fs,pktsize)\n sigq.append(sigqi)\n sigq=np.concatenate(sigq,0)\n return sigq\n \n ppfn= butterfilt_and_downsample(order=6, stopband='butter_stopband((0, 5), (25, -1))_fs200.pk', fs_out=100)\n ppfn.fit(X[:10,:],fs=200)\n noise2sig = np.zeros((int(X.shape[0]/pktsize),X.shape[-1]),dtype=np.float32)\n for pkti in range(noise2sig.shape[0]):\n t = pkti*pktsize\n Xi = X[t:t+pktsize,:]\n Xip = ppfn.transform(Xi)\n raw_power, preproc_power = UtopiaDataInterface.update_electrode_powers(Xi,Xip)\n noise2sig[pkti,:] = np.maximum(float(1e-6), (raw_power - preproc_power)) / np.maximum(float(1e-8),preproc_power)\n return noise2sig\n\n \nif __name__ == \"__main__\":\n #timestamp_interpolation().testcase()\n #butterfilt_and_downsample.testcase()\n #testRaw()\n #testPP()\n #testERP()\n filename=\"~/Desktop/mark/mindaffectBCI_*.txt\"\n testFileProxy(filename)\n #testFileProxy2(filename)\n # \"C:\\\\Users\\\\Developer\\\\Downloads\\\\mark\\\\mindaffectBCI_brainflow_200911_1229_90cal.txt\")\n #\"..\\..\\Downloads\\khash\\mindaffectBCI_noisetag_bci_200907_1433.txt\"\n"}}},{"rowIdx":1086,"cells":{"function_name":{"kind":"string","value":"_get_slice_len"},"docstring":{"kind":"string","value":"Get the number of elements in a slice.\n\nParameters\n----------\nidx : np.ndarray\n A (3,) shaped array containing start, stop, step\n\nReturns\n-------\nn : int\n The length of the slice.\n\nExamples\n--------\n>>> idx = np.array([5, 15, 5])\n>>> _get_slice_len(idx)\n2"},"masked_code":{"kind":"string","value":"#pythran export compute_mask(int[:,:], int[:,:])\n#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)\n\nimport numpy as np\ndef compute_mask(coords, indices): # pragma: no cover\n \"\"\"\n Gets the mask for the coords given the indices in slice format.\n\n Works with either start-stop ranges of matching indices into coords\n called \"pairs\" (start-stop pairs) or filters the mask directly, based\n on which is faster.\n\n Exploits the structure in sorted coords, which is that for a constant\n value of coords[i - 1], coords[i - 2] and so on, coords[i] is sorted.\n Concretely, ``coords[i, coords[i - 1] == v1 & coords[i - 2] = v2, ...]``\n is always sorted. It uses this sortedness to find sub-pairs for each\n dimension given the previous, and so on. This is efficient for small\n slices or ints, but not for large ones.\n\n After it detects that working with pairs is rather inefficient (or after\n going through each possible index), it constructs a filtered mask from the\n start-stop pairs.\n\n Parameters\n ----------\n coords : np.ndarray\n The coordinates of the array.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : np.ndarray\n The starts and stops in the mask.\n is_slice : bool\n Whether or not the array represents a continuous slice.\n\n Examples\n --------\n Let's create some mock coords and indices\n\n >>> import numpy as np\n >>> coords = np.array([[0, 0, 1, 1, 2, 2]])\n >>> indices = np.array([[0, 3, 2]]) # Equivalent to slice(0, 3, 2)\n\n Now let's get the mask. Notice that the indices of ``0`` and ``2`` are matched.\n\n >>> _compute_mask(coords, indices)\n (array([0, 1, 4, 5]), False)\n\n Now, let's try with a more \"continuous\" slice. Matches ``0`` and ``1``.\n\n >>> indices = np.array([[0, 2, 1]])\n >>> _compute_mask(coords, indices)\n (array([0, 4]), True)\n\n This is equivalent to mask being ``slice(0, 4, 1)``.\n \"\"\"\n # Set the initial mask to be the entire range of coordinates.\n starts = [0]\n stops = [coords.shape[1]]\n n_matches = coords.shape[1]\n\n i = 0\n while i < len(indices):\n # Guesstimate whether working with pairs is more efficient or\n # working with the mask directly.\n # One side is the estimate of time taken for binary searches\n # (n_searches * log(avg_length))\n # The other is an estimated time of a linear filter for the mask.\n n_pairs = len(starts)\n n_current_slices = _get_slice_len(indices[i]) * n_pairs + 2\n if n_current_slices * np.log(n_current_slices / max(n_pairs, 1)) > \\\n n_matches + n_pairs:\n break\n\n # For each of the pairs, search inside the coordinates for other\n # matching sub-pairs.\n # This gets the start-end coordinates in coords for each 'sub-array'\n # Which would come out of indexing a single integer.\n starts, stops, n_matches = _get_mask_pairs(starts, stops, coords[i], indices[i])\n\n i += 1\n\n # Combine adjacent pairs\n starts, stops = _join_adjacent_pairs(starts, stops)\n\n # If just one pair is left over, treat it as a slice.\n if i == len(indices) and len(starts) == 1:\n return np.array([starts[0], stops[0]]), True\n\n # Convert start-stop pairs into mask, filtering by remaining\n # coordinates.\n mask = _filter_pairs(starts, stops, coords[i:], indices[i:])\n\n return np.array(mask, dtype=np.intp), False\n\n\n# MASKED: _get_slice_len function (lines 100-125)\n\n\ndef _get_mask_pairs(starts_old, stops_old, c, idx): # pragma: no cover\n \"\"\"\n Gets the pairs for a following dimension given the pairs for\n a dimension.\n\n For each pair, it searches in the following dimension for\n matching coords and returns those.\n\n The total combined length of all pairs is returned to\n help with the performance guesstimate.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The starts and stops from the previous index.\n c : np.ndarray\n The coords for this index's dimension.\n idx : np.ndarray\n The index in the form of a slice.\n idx[0], idx[1], idx[2] = start, stop, step\n\n Returns\n -------\n starts, stops: list\n The starts and stops after applying the current index.\n n_matches : int\n The sum of elements in all ranges.\n\n Examples\n --------\n >>> c = np.array([1, 2, 1, 2, 1, 1, 2, 2])\n >>> starts_old = [4]\n >>> stops_old = [8]\n >>> idx = np.array([1, 2, 1])\n >>> _get_mask_pairs(starts_old, stops_old, c, idx)\n ([4], [6], 2)\n \"\"\"\n starts = []\n stops = []\n n_matches = 0\n\n for j in range(len(starts_old)):\n # For each matching \"integer\" in the slice, search within the \"sub-coords\"\n # Using binary search.\n for p_match in range(idx[0], idx[1], idx[2]):\n start = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match) + starts_old[j]\n stop = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match + 1) + starts_old[j]\n\n if start != stop:\n starts.append(start)\n stops.append(stop)\n n_matches += stop - start\n\n return starts, stops, n_matches\n\ndef _join_adjacent_pairs(starts_old, stops_old): # pragma: no cover\n \"\"\"\n Joins adjacent pairs into one. For example, 2-5 and 5-7\n will reduce to 2-7 (a single pair). This may help in\n returning a slice in the end which could be faster.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The input starts and stops\n\n Returns\n -------\n starts, stops : list[int]\n The reduced starts and stops.\n\n Examples\n --------\n >>> starts = [2, 5]\n >>> stops = [5, 7]\n >>> _join_adjacent_pairs(starts, stops)\n ([2], [7])\n \"\"\"\n if len(starts_old) <= 1:\n return starts_old, stops_old\n\n starts = [starts_old[0]]\n stops = []\n\n for i in range(1, len(starts_old)):\n if starts_old[i] != stops_old[i - 1]:\n starts.append(starts_old[i])\n stops.append(stops_old[i - 1])\n\n stops.append(stops_old[-1])\n\n return starts, stops\n\ndef _filter_pairs(starts, stops, coords, indices): # pragma: no cover\n \"\"\"\n Converts all the pairs into a single integer mask, additionally filtering\n by the indices.\n\n Parameters\n ----------\n starts, stops : list[int]\n The starts and stops to convert into an array.\n coords : np.ndarray\n The coordinates to filter by.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : list\n The output integer mask.\n\n Examples\n --------\n >>> import numpy as np\n >>> starts = [2]\n >>> stops = [7]\n >>> coords = np.array([[0, 1, 2, 3, 4, 5, 6, 7]])\n >>> indices = np.array([[2, 8, 2]]) # Start, stop, step pairs\n >>> _filter_pairs(starts, stops, coords, indices)\n [2, 4, 6]\n \"\"\"\n mask = []\n\n # For each pair,\n for i in range(len(starts)):\n # For each element match within the pair range\n for j in range(starts[i], stops[i]):\n match = True\n\n # Check if it matches all indices\n for k in range(len(indices)):\n idx = indices[k]\n elem = coords[k, j]\n\n match &= ((elem - idx[0]) % idx[2] == 0 and\n ((idx[2] > 0 and idx[0] <= elem < idx[1])\n or (idx[2] < 0 and idx[0] >= elem > idx[1])))\n\n # and append to the mask if so.\n if match:\n mask.append(j)\n\n return mask"},"implementation":{"kind":"string","value":"def _get_slice_len(idx):\n \"\"\"\n Get the number of elements in a slice.\n\n Parameters\n ----------\n idx : np.ndarray\n A (3,) shaped array containing start, stop, step\n\n Returns\n -------\n n : int\n The length of the slice.\n\n Examples\n --------\n >>> idx = np.array([5, 15, 5])\n >>> _get_slice_len(idx)\n 2\n \"\"\"\n start, stop, step = idx[0], idx[1], idx[2]\n\n if step > 0:\n return (stop - start + step - 1) // step\n else:\n return (start - stop - step - 1) // (-step)"},"start_line":{"kind":"number","value":100,"string":"100"},"end_line":{"kind":"number","value":125,"string":"125"},"file_content":{"kind":"string","value":"#pythran export compute_mask(int[:,:], int[:,:])\n#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)\n\nimport numpy as np\ndef compute_mask(coords, indices): # pragma: no cover\n \"\"\"\n Gets the mask for the coords given the indices in slice format.\n\n Works with either start-stop ranges of matching indices into coords\n called \"pairs\" (start-stop pairs) or filters the mask directly, based\n on which is faster.\n\n Exploits the structure in sorted coords, which is that for a constant\n value of coords[i - 1], coords[i - 2] and so on, coords[i] is sorted.\n Concretely, ``coords[i, coords[i - 1] == v1 & coords[i - 2] = v2, ...]``\n is always sorted. It uses this sortedness to find sub-pairs for each\n dimension given the previous, and so on. This is efficient for small\n slices or ints, but not for large ones.\n\n After it detects that working with pairs is rather inefficient (or after\n going through each possible index), it constructs a filtered mask from the\n start-stop pairs.\n\n Parameters\n ----------\n coords : np.ndarray\n The coordinates of the array.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : np.ndarray\n The starts and stops in the mask.\n is_slice : bool\n Whether or not the array represents a continuous slice.\n\n Examples\n --------\n Let's create some mock coords and indices\n\n >>> import numpy as np\n >>> coords = np.array([[0, 0, 1, 1, 2, 2]])\n >>> indices = np.array([[0, 3, 2]]) # Equivalent to slice(0, 3, 2)\n\n Now let's get the mask. Notice that the indices of ``0`` and ``2`` are matched.\n\n >>> _compute_mask(coords, indices)\n (array([0, 1, 4, 5]), False)\n\n Now, let's try with a more \"continuous\" slice. Matches ``0`` and ``1``.\n\n >>> indices = np.array([[0, 2, 1]])\n >>> _compute_mask(coords, indices)\n (array([0, 4]), True)\n\n This is equivalent to mask being ``slice(0, 4, 1)``.\n \"\"\"\n # Set the initial mask to be the entire range of coordinates.\n starts = [0]\n stops = [coords.shape[1]]\n n_matches = coords.shape[1]\n\n i = 0\n while i < len(indices):\n # Guesstimate whether working with pairs is more efficient or\n # working with the mask directly.\n # One side is the estimate of time taken for binary searches\n # (n_searches * log(avg_length))\n # The other is an estimated time of a linear filter for the mask.\n n_pairs = len(starts)\n n_current_slices = _get_slice_len(indices[i]) * n_pairs + 2\n if n_current_slices * np.log(n_current_slices / max(n_pairs, 1)) > \\\n n_matches + n_pairs:\n break\n\n # For each of the pairs, search inside the coordinates for other\n # matching sub-pairs.\n # This gets the start-end coordinates in coords for each 'sub-array'\n # Which would come out of indexing a single integer.\n starts, stops, n_matches = _get_mask_pairs(starts, stops, coords[i], indices[i])\n\n i += 1\n\n # Combine adjacent pairs\n starts, stops = _join_adjacent_pairs(starts, stops)\n\n # If just one pair is left over, treat it as a slice.\n if i == len(indices) and len(starts) == 1:\n return np.array([starts[0], stops[0]]), True\n\n # Convert start-stop pairs into mask, filtering by remaining\n # coordinates.\n mask = _filter_pairs(starts, stops, coords[i:], indices[i:])\n\n return np.array(mask, dtype=np.intp), False\n\n\ndef _get_slice_len(idx):\n \"\"\"\n Get the number of elements in a slice.\n\n Parameters\n ----------\n idx : np.ndarray\n A (3,) shaped array containing start, stop, step\n\n Returns\n -------\n n : int\n The length of the slice.\n\n Examples\n --------\n >>> idx = np.array([5, 15, 5])\n >>> _get_slice_len(idx)\n 2\n \"\"\"\n start, stop, step = idx[0], idx[1], idx[2]\n\n if step > 0:\n return (stop - start + step - 1) // step\n else:\n return (start - stop - step - 1) // (-step)\n\n\ndef _get_mask_pairs(starts_old, stops_old, c, idx): # pragma: no cover\n \"\"\"\n Gets the pairs for a following dimension given the pairs for\n a dimension.\n\n For each pair, it searches in the following dimension for\n matching coords and returns those.\n\n The total combined length of all pairs is returned to\n help with the performance guesstimate.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The starts and stops from the previous index.\n c : np.ndarray\n The coords for this index's dimension.\n idx : np.ndarray\n The index in the form of a slice.\n idx[0], idx[1], idx[2] = start, stop, step\n\n Returns\n -------\n starts, stops: list\n The starts and stops after applying the current index.\n n_matches : int\n The sum of elements in all ranges.\n\n Examples\n --------\n >>> c = np.array([1, 2, 1, 2, 1, 1, 2, 2])\n >>> starts_old = [4]\n >>> stops_old = [8]\n >>> idx = np.array([1, 2, 1])\n >>> _get_mask_pairs(starts_old, stops_old, c, idx)\n ([4], [6], 2)\n \"\"\"\n starts = []\n stops = []\n n_matches = 0\n\n for j in range(len(starts_old)):\n # For each matching \"integer\" in the slice, search within the \"sub-coords\"\n # Using binary search.\n for p_match in range(idx[0], idx[1], idx[2]):\n start = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match) + starts_old[j]\n stop = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match + 1) + starts_old[j]\n\n if start != stop:\n starts.append(start)\n stops.append(stop)\n n_matches += stop - start\n\n return starts, stops, n_matches\n\ndef _join_adjacent_pairs(starts_old, stops_old): # pragma: no cover\n \"\"\"\n Joins adjacent pairs into one. For example, 2-5 and 5-7\n will reduce to 2-7 (a single pair). This may help in\n returning a slice in the end which could be faster.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The input starts and stops\n\n Returns\n -------\n starts, stops : list[int]\n The reduced starts and stops.\n\n Examples\n --------\n >>> starts = [2, 5]\n >>> stops = [5, 7]\n >>> _join_adjacent_pairs(starts, stops)\n ([2], [7])\n \"\"\"\n if len(starts_old) <= 1:\n return starts_old, stops_old\n\n starts = [starts_old[0]]\n stops = []\n\n for i in range(1, len(starts_old)):\n if starts_old[i] != stops_old[i - 1]:\n starts.append(starts_old[i])\n stops.append(stops_old[i - 1])\n\n stops.append(stops_old[-1])\n\n return starts, stops\n\ndef _filter_pairs(starts, stops, coords, indices): # pragma: no cover\n \"\"\"\n Converts all the pairs into a single integer mask, additionally filtering\n by the indices.\n\n Parameters\n ----------\n starts, stops : list[int]\n The starts and stops to convert into an array.\n coords : np.ndarray\n The coordinates to filter by.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : list\n The output integer mask.\n\n Examples\n --------\n >>> import numpy as np\n >>> starts = [2]\n >>> stops = [7]\n >>> coords = np.array([[0, 1, 2, 3, 4, 5, 6, 7]])\n >>> indices = np.array([[2, 8, 2]]) # Start, stop, step pairs\n >>> _filter_pairs(starts, stops, coords, indices)\n [2, 4, 6]\n \"\"\"\n mask = []\n\n # For each pair,\n for i in range(len(starts)):\n # For each element match within the pair range\n for j in range(starts[i], stops[i]):\n match = True\n\n # Check if it matches all indices\n for k in range(len(indices)):\n idx = indices[k]\n elem = coords[k, j]\n\n match &= ((elem - idx[0]) % idx[2] == 0 and\n ((idx[2] > 0 and idx[0] <= elem < idx[1])\n or (idx[2] < 0 and idx[0] >= elem > idx[1])))\n\n # and append to the mask if so.\n if match:\n mask.append(j)\n\n return mask\n"}}},{"rowIdx":1087,"cells":{"function_name":{"kind":"string","value":"_filter_pairs"},"docstring":{"kind":"string","value":"Converts all the pairs into a single integer mask, additionally filtering\nby the indices.\n\nParameters\n----------\nstarts, stops : list[int]\n The starts and stops to convert into an array.\ncoords : np.ndarray\n The coordinates to filter by.\nindices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\nReturns\n-------\nmask : list\n The output integer mask.\n\nExamples\n--------\n>>> import numpy as np\n>>> starts = [2]\n>>> stops = [7]\n>>> coords = np.array([[0, 1, 2, 3, 4, 5, 6, 7]])\n>>> indices = np.array([[2, 8, 2]]) # Start, stop, step pairs\n>>> _filter_pairs(starts, stops, coords, indices)\n[2, 4, 6]"},"masked_code":{"kind":"string","value":"#pythran export compute_mask(int[:,:], int[:,:])\n#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)\n\nimport numpy as np\ndef compute_mask(coords, indices): # pragma: no cover\n \"\"\"\n Gets the mask for the coords given the indices in slice format.\n\n Works with either start-stop ranges of matching indices into coords\n called \"pairs\" (start-stop pairs) or filters the mask directly, based\n on which is faster.\n\n Exploits the structure in sorted coords, which is that for a constant\n value of coords[i - 1], coords[i - 2] and so on, coords[i] is sorted.\n Concretely, ``coords[i, coords[i - 1] == v1 & coords[i - 2] = v2, ...]``\n is always sorted. It uses this sortedness to find sub-pairs for each\n dimension given the previous, and so on. This is efficient for small\n slices or ints, but not for large ones.\n\n After it detects that working with pairs is rather inefficient (or after\n going through each possible index), it constructs a filtered mask from the\n start-stop pairs.\n\n Parameters\n ----------\n coords : np.ndarray\n The coordinates of the array.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : np.ndarray\n The starts and stops in the mask.\n is_slice : bool\n Whether or not the array represents a continuous slice.\n\n Examples\n --------\n Let's create some mock coords and indices\n\n >>> import numpy as np\n >>> coords = np.array([[0, 0, 1, 1, 2, 2]])\n >>> indices = np.array([[0, 3, 2]]) # Equivalent to slice(0, 3, 2)\n\n Now let's get the mask. Notice that the indices of ``0`` and ``2`` are matched.\n\n >>> _compute_mask(coords, indices)\n (array([0, 1, 4, 5]), False)\n\n Now, let's try with a more \"continuous\" slice. Matches ``0`` and ``1``.\n\n >>> indices = np.array([[0, 2, 1]])\n >>> _compute_mask(coords, indices)\n (array([0, 4]), True)\n\n This is equivalent to mask being ``slice(0, 4, 1)``.\n \"\"\"\n # Set the initial mask to be the entire range of coordinates.\n starts = [0]\n stops = [coords.shape[1]]\n n_matches = coords.shape[1]\n\n i = 0\n while i < len(indices):\n # Guesstimate whether working with pairs is more efficient or\n # working with the mask directly.\n # One side is the estimate of time taken for binary searches\n # (n_searches * log(avg_length))\n # The other is an estimated time of a linear filter for the mask.\n n_pairs = len(starts)\n n_current_slices = _get_slice_len(indices[i]) * n_pairs + 2\n if n_current_slices * np.log(n_current_slices / max(n_pairs, 1)) > \\\n n_matches + n_pairs:\n break\n\n # For each of the pairs, search inside the coordinates for other\n # matching sub-pairs.\n # This gets the start-end coordinates in coords for each 'sub-array'\n # Which would come out of indexing a single integer.\n starts, stops, n_matches = _get_mask_pairs(starts, stops, coords[i], indices[i])\n\n i += 1\n\n # Combine adjacent pairs\n starts, stops = _join_adjacent_pairs(starts, stops)\n\n # If just one pair is left over, treat it as a slice.\n if i == len(indices) and len(starts) == 1:\n return np.array([starts[0], stops[0]]), True\n\n # Convert start-stop pairs into mask, filtering by remaining\n # coordinates.\n mask = _filter_pairs(starts, stops, coords[i:], indices[i:])\n\n return np.array(mask, dtype=np.intp), False\n\n\ndef _get_slice_len(idx):\n \"\"\"\n Get the number of elements in a slice.\n\n Parameters\n ----------\n idx : np.ndarray\n A (3,) shaped array containing start, stop, step\n\n Returns\n -------\n n : int\n The length of the slice.\n\n Examples\n --------\n >>> idx = np.array([5, 15, 5])\n >>> _get_slice_len(idx)\n 2\n \"\"\"\n start, stop, step = idx[0], idx[1], idx[2]\n\n if step > 0:\n return (stop - start + step - 1) // step\n else:\n return (start - stop - step - 1) // (-step)\n\n\ndef _get_mask_pairs(starts_old, stops_old, c, idx): # pragma: no cover\n \"\"\"\n Gets the pairs for a following dimension given the pairs for\n a dimension.\n\n For each pair, it searches in the following dimension for\n matching coords and returns those.\n\n The total combined length of all pairs is returned to\n help with the performance guesstimate.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The starts and stops from the previous index.\n c : np.ndarray\n The coords for this index's dimension.\n idx : np.ndarray\n The index in the form of a slice.\n idx[0], idx[1], idx[2] = start, stop, step\n\n Returns\n -------\n starts, stops: list\n The starts and stops after applying the current index.\n n_matches : int\n The sum of elements in all ranges.\n\n Examples\n --------\n >>> c = np.array([1, 2, 1, 2, 1, 1, 2, 2])\n >>> starts_old = [4]\n >>> stops_old = [8]\n >>> idx = np.array([1, 2, 1])\n >>> _get_mask_pairs(starts_old, stops_old, c, idx)\n ([4], [6], 2)\n \"\"\"\n starts = []\n stops = []\n n_matches = 0\n\n for j in range(len(starts_old)):\n # For each matching \"integer\" in the slice, search within the \"sub-coords\"\n # Using binary search.\n for p_match in range(idx[0], idx[1], idx[2]):\n start = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match) + starts_old[j]\n stop = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match + 1) + starts_old[j]\n\n if start != stop:\n starts.append(start)\n stops.append(stop)\n n_matches += stop - start\n\n return starts, stops, n_matches\n\ndef _join_adjacent_pairs(starts_old, stops_old): # pragma: no cover\n \"\"\"\n Joins adjacent pairs into one. For example, 2-5 and 5-7\n will reduce to 2-7 (a single pair). This may help in\n returning a slice in the end which could be faster.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The input starts and stops\n\n Returns\n -------\n starts, stops : list[int]\n The reduced starts and stops.\n\n Examples\n --------\n >>> starts = [2, 5]\n >>> stops = [5, 7]\n >>> _join_adjacent_pairs(starts, stops)\n ([2], [7])\n \"\"\"\n if len(starts_old) <= 1:\n return starts_old, stops_old\n\n starts = [starts_old[0]]\n stops = []\n\n for i in range(1, len(starts_old)):\n if starts_old[i] != stops_old[i - 1]:\n starts.append(starts_old[i])\n stops.append(stops_old[i - 1])\n\n stops.append(stops_old[-1])\n\n return starts, stops\n\n# MASKED: _filter_pairs function (lines 221-272)"},"implementation":{"kind":"string","value":"def _filter_pairs(starts, stops, coords, indices): # pragma: no cover\n \"\"\"\n Converts all the pairs into a single integer mask, additionally filtering\n by the indices.\n\n Parameters\n ----------\n starts, stops : list[int]\n The starts and stops to convert into an array.\n coords : np.ndarray\n The coordinates to filter by.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : list\n The output integer mask.\n\n Examples\n --------\n >>> import numpy as np\n >>> starts = [2]\n >>> stops = [7]\n >>> coords = np.array([[0, 1, 2, 3, 4, 5, 6, 7]])\n >>> indices = np.array([[2, 8, 2]]) # Start, stop, step pairs\n >>> _filter_pairs(starts, stops, coords, indices)\n [2, 4, 6]\n \"\"\"\n mask = []\n\n # For each pair,\n for i in range(len(starts)):\n # For each element match within the pair range\n for j in range(starts[i], stops[i]):\n match = True\n\n # Check if it matches all indices\n for k in range(len(indices)):\n idx = indices[k]\n elem = coords[k, j]\n\n match &= ((elem - idx[0]) % idx[2] == 0 and\n ((idx[2] > 0 and idx[0] <= elem < idx[1])\n or (idx[2] < 0 and idx[0] >= elem > idx[1])))\n\n # and append to the mask if so.\n if match:\n mask.append(j)\n\n return mask"},"start_line":{"kind":"number","value":221,"string":"221"},"end_line":{"kind":"number","value":272,"string":"272"},"file_content":{"kind":"string","value":"#pythran export compute_mask(int[:,:], int[:,:])\n#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)\n\nimport numpy as np\ndef compute_mask(coords, indices): # pragma: no cover\n \"\"\"\n Gets the mask for the coords given the indices in slice format.\n\n Works with either start-stop ranges of matching indices into coords\n called \"pairs\" (start-stop pairs) or filters the mask directly, based\n on which is faster.\n\n Exploits the structure in sorted coords, which is that for a constant\n value of coords[i - 1], coords[i - 2] and so on, coords[i] is sorted.\n Concretely, ``coords[i, coords[i - 1] == v1 & coords[i - 2] = v2, ...]``\n is always sorted. It uses this sortedness to find sub-pairs for each\n dimension given the previous, and so on. This is efficient for small\n slices or ints, but not for large ones.\n\n After it detects that working with pairs is rather inefficient (or after\n going through each possible index), it constructs a filtered mask from the\n start-stop pairs.\n\n Parameters\n ----------\n coords : np.ndarray\n The coordinates of the array.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : np.ndarray\n The starts and stops in the mask.\n is_slice : bool\n Whether or not the array represents a continuous slice.\n\n Examples\n --------\n Let's create some mock coords and indices\n\n >>> import numpy as np\n >>> coords = np.array([[0, 0, 1, 1, 2, 2]])\n >>> indices = np.array([[0, 3, 2]]) # Equivalent to slice(0, 3, 2)\n\n Now let's get the mask. Notice that the indices of ``0`` and ``2`` are matched.\n\n >>> _compute_mask(coords, indices)\n (array([0, 1, 4, 5]), False)\n\n Now, let's try with a more \"continuous\" slice. Matches ``0`` and ``1``.\n\n >>> indices = np.array([[0, 2, 1]])\n >>> _compute_mask(coords, indices)\n (array([0, 4]), True)\n\n This is equivalent to mask being ``slice(0, 4, 1)``.\n \"\"\"\n # Set the initial mask to be the entire range of coordinates.\n starts = [0]\n stops = [coords.shape[1]]\n n_matches = coords.shape[1]\n\n i = 0\n while i < len(indices):\n # Guesstimate whether working with pairs is more efficient or\n # working with the mask directly.\n # One side is the estimate of time taken for binary searches\n # (n_searches * log(avg_length))\n # The other is an estimated time of a linear filter for the mask.\n n_pairs = len(starts)\n n_current_slices = _get_slice_len(indices[i]) * n_pairs + 2\n if n_current_slices * np.log(n_current_slices / max(n_pairs, 1)) > \\\n n_matches + n_pairs:\n break\n\n # For each of the pairs, search inside the coordinates for other\n # matching sub-pairs.\n # This gets the start-end coordinates in coords for each 'sub-array'\n # Which would come out of indexing a single integer.\n starts, stops, n_matches = _get_mask_pairs(starts, stops, coords[i], indices[i])\n\n i += 1\n\n # Combine adjacent pairs\n starts, stops = _join_adjacent_pairs(starts, stops)\n\n # If just one pair is left over, treat it as a slice.\n if i == len(indices) and len(starts) == 1:\n return np.array([starts[0], stops[0]]), True\n\n # Convert start-stop pairs into mask, filtering by remaining\n # coordinates.\n mask = _filter_pairs(starts, stops, coords[i:], indices[i:])\n\n return np.array(mask, dtype=np.intp), False\n\n\ndef _get_slice_len(idx):\n \"\"\"\n Get the number of elements in a slice.\n\n Parameters\n ----------\n idx : np.ndarray\n A (3,) shaped array containing start, stop, step\n\n Returns\n -------\n n : int\n The length of the slice.\n\n Examples\n --------\n >>> idx = np.array([5, 15, 5])\n >>> _get_slice_len(idx)\n 2\n \"\"\"\n start, stop, step = idx[0], idx[1], idx[2]\n\n if step > 0:\n return (stop - start + step - 1) // step\n else:\n return (start - stop - step - 1) // (-step)\n\n\ndef _get_mask_pairs(starts_old, stops_old, c, idx): # pragma: no cover\n \"\"\"\n Gets the pairs for a following dimension given the pairs for\n a dimension.\n\n For each pair, it searches in the following dimension for\n matching coords and returns those.\n\n The total combined length of all pairs is returned to\n help with the performance guesstimate.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The starts and stops from the previous index.\n c : np.ndarray\n The coords for this index's dimension.\n idx : np.ndarray\n The index in the form of a slice.\n idx[0], idx[1], idx[2] = start, stop, step\n\n Returns\n -------\n starts, stops: list\n The starts and stops after applying the current index.\n n_matches : int\n The sum of elements in all ranges.\n\n Examples\n --------\n >>> c = np.array([1, 2, 1, 2, 1, 1, 2, 2])\n >>> starts_old = [4]\n >>> stops_old = [8]\n >>> idx = np.array([1, 2, 1])\n >>> _get_mask_pairs(starts_old, stops_old, c, idx)\n ([4], [6], 2)\n \"\"\"\n starts = []\n stops = []\n n_matches = 0\n\n for j in range(len(starts_old)):\n # For each matching \"integer\" in the slice, search within the \"sub-coords\"\n # Using binary search.\n for p_match in range(idx[0], idx[1], idx[2]):\n start = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match) + starts_old[j]\n stop = np.searchsorted(c[starts_old[j]:stops_old[j]], p_match + 1) + starts_old[j]\n\n if start != stop:\n starts.append(start)\n stops.append(stop)\n n_matches += stop - start\n\n return starts, stops, n_matches\n\ndef _join_adjacent_pairs(starts_old, stops_old): # pragma: no cover\n \"\"\"\n Joins adjacent pairs into one. For example, 2-5 and 5-7\n will reduce to 2-7 (a single pair). This may help in\n returning a slice in the end which could be faster.\n\n Parameters\n ----------\n starts_old, stops_old : list[int]\n The input starts and stops\n\n Returns\n -------\n starts, stops : list[int]\n The reduced starts and stops.\n\n Examples\n --------\n >>> starts = [2, 5]\n >>> stops = [5, 7]\n >>> _join_adjacent_pairs(starts, stops)\n ([2], [7])\n \"\"\"\n if len(starts_old) <= 1:\n return starts_old, stops_old\n\n starts = [starts_old[0]]\n stops = []\n\n for i in range(1, len(starts_old)):\n if starts_old[i] != stops_old[i - 1]:\n starts.append(starts_old[i])\n stops.append(stops_old[i - 1])\n\n stops.append(stops_old[-1])\n\n return starts, stops\n\ndef _filter_pairs(starts, stops, coords, indices): # pragma: no cover\n \"\"\"\n Converts all the pairs into a single integer mask, additionally filtering\n by the indices.\n\n Parameters\n ----------\n starts, stops : list[int]\n The starts and stops to convert into an array.\n coords : np.ndarray\n The coordinates to filter by.\n indices : np.ndarray\n The indices in the form of slices such that indices[:, 0] are starts,\n indices[:, 1] are stops and indices[:, 2] are steps.\n\n Returns\n -------\n mask : list\n The output integer mask.\n\n Examples\n --------\n >>> import numpy as np\n >>> starts = [2]\n >>> stops = [7]\n >>> coords = np.array([[0, 1, 2, 3, 4, 5, 6, 7]])\n >>> indices = np.array([[2, 8, 2]]) # Start, stop, step pairs\n >>> _filter_pairs(starts, stops, coords, indices)\n [2, 4, 6]\n \"\"\"\n mask = []\n\n # For each pair,\n for i in range(len(starts)):\n # For each element match within the pair range\n for j in range(starts[i], stops[i]):\n match = True\n\n # Check if it matches all indices\n for k in range(len(indices)):\n idx = indices[k]\n elem = coords[k, j]\n\n match &= ((elem - idx[0]) % idx[2] == 0 and\n ((idx[2] > 0 and idx[0] <= elem < idx[1])\n or (idx[2] < 0 and idx[0] >= elem > idx[1])))\n\n # and append to the mask if so.\n if match:\n mask.append(j)\n\n return mask\n"}}},{"rowIdx":1088,"cells":{"function_name":{"kind":"string","value":"collect_annotations"},"docstring":{"kind":"string","value":"Collect the annotation information.\n\nArgs:\n files (list): The list of tuples (image_file, groundtruth_file)\n nproc (int): The number of process to collect annotations\n\nReturns:\n images (list): The list of image information dicts"},"masked_code":{"kind":"string","value":"# Copyright (c) OpenMMLab. All rights reserved.\nimport argparse\nimport math\nimport os\nimport os.path as osp\n\nimport mmcv\n\nfrom mmocr.utils import convert_annotations\n\n\ndef collect_files(img_dir, gt_dir):\n \"\"\"Collect all images and their corresponding groundtruth files.\n\n Args:\n img_dir (str): The image directory\n gt_dir (str): The groundtruth directory\n\n Returns:\n files (list): The list of tuples (img_file, groundtruth_file)\n \"\"\"\n assert isinstance(img_dir, str)\n assert img_dir\n assert isinstance(gt_dir, str)\n assert gt_dir\n\n ann_list, imgs_list = [], []\n for gt_file in os.listdir(gt_dir):\n ann_list.append(osp.join(gt_dir, gt_file))\n imgs_list.append(osp.join(img_dir, gt_file.replace('.json', '.png')))\n\n files = list(zip(sorted(imgs_list), sorted(ann_list)))\n assert len(files), f'No images found in {img_dir}'\n print(f'Loaded {len(files)} images from {img_dir}')\n\n return files\n\n\n# MASKED: collect_annotations function (lines 39-58)\n\n\ndef load_img_info(files):\n \"\"\"Load the information of one image.\n\n Args:\n files (tuple): The tuple of (img_file, groundtruth_file)\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n assert isinstance(files, tuple)\n\n img_file, gt_file = files\n assert osp.basename(gt_file).split('.')[0] == osp.basename(img_file).split(\n '.')[0]\n # read imgs while ignoring orientations\n img = mmcv.imread(img_file, 'unchanged')\n\n img_info = dict(\n file_name=osp.join(osp.basename(img_file)),\n height=img.shape[0],\n width=img.shape[1],\n segm_file=osp.join(osp.basename(gt_file)))\n\n if osp.splitext(gt_file)[1] == '.json':\n img_info = load_json_info(gt_file, img_info)\n else:\n raise NotImplementedError\n\n return img_info\n\n\ndef load_json_info(gt_file, img_info):\n \"\"\"Collect the annotation information.\n\n Args:\n gt_file (str): The path to ground-truth\n img_info (dict): The dict of the img and annotation information\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n\n annotation = mmcv.load(gt_file)\n anno_info = []\n for form in annotation['form']:\n for ann in form['words']:\n\n iscrowd = 1 if len(ann['text']) == 0 else 0\n\n x1, y1, x2, y2 = ann['box']\n x = max(0, min(math.floor(x1), math.floor(x2)))\n y = max(0, min(math.floor(y1), math.floor(y2)))\n w, h = math.ceil(abs(x2 - x1)), math.ceil(abs(y2 - y1))\n bbox = [x, y, w, h]\n segmentation = [x, y, x + w, y, x + w, y + h, x, y + h]\n\n anno = dict(\n iscrowd=iscrowd,\n category_id=1,\n bbox=bbox,\n area=w * h,\n segmentation=[segmentation])\n anno_info.append(anno)\n\n img_info.update(anno_info=anno_info)\n\n return img_info\n\n\ndef parse_args():\n parser = argparse.ArgumentParser(\n description='Generate training and test set of FUNSD ')\n parser.add_argument('root_path', help='Root dir path of FUNSD')\n parser.add_argument(\n '--nproc', default=1, type=int, help='Number of process')\n args = parser.parse_args()\n return args\n\n\ndef main():\n args = parse_args()\n root_path = args.root_path\n\n for split in ['training', 'test']:\n print(f'Processing {split} set...')\n with mmcv.Timer(print_tmpl='It takes {}s to convert FUNSD annotation'):\n files = collect_files(\n osp.join(root_path, 'imgs'),\n osp.join(root_path, 'annotations', split))\n image_infos = collect_annotations(files, nproc=args.nproc)\n convert_annotations(\n image_infos, osp.join(root_path,\n 'instances_' + split + '.json'))\n\n\nif __name__ == '__main__':\n main()"},"implementation":{"kind":"string","value":"def collect_annotations(files, nproc=1):\n \"\"\"Collect the annotation information.\n\n Args:\n files (list): The list of tuples (image_file, groundtruth_file)\n nproc (int): The number of process to collect annotations\n\n Returns:\n images (list): The list of image information dicts\n \"\"\"\n assert isinstance(files, list)\n assert isinstance(nproc, int)\n\n if nproc > 1:\n images = mmcv.track_parallel_progress(\n load_img_info, files, nproc=nproc)\n else:\n images = mmcv.track_progress(load_img_info, files)\n\n return images"},"start_line":{"kind":"number","value":39,"string":"39"},"end_line":{"kind":"number","value":58,"string":"58"},"file_content":{"kind":"string","value":"# Copyright (c) OpenMMLab. All rights reserved.\nimport argparse\nimport math\nimport os\nimport os.path as osp\n\nimport mmcv\n\nfrom mmocr.utils import convert_annotations\n\n\ndef collect_files(img_dir, gt_dir):\n \"\"\"Collect all images and their corresponding groundtruth files.\n\n Args:\n img_dir (str): The image directory\n gt_dir (str): The groundtruth directory\n\n Returns:\n files (list): The list of tuples (img_file, groundtruth_file)\n \"\"\"\n assert isinstance(img_dir, str)\n assert img_dir\n assert isinstance(gt_dir, str)\n assert gt_dir\n\n ann_list, imgs_list = [], []\n for gt_file in os.listdir(gt_dir):\n ann_list.append(osp.join(gt_dir, gt_file))\n imgs_list.append(osp.join(img_dir, gt_file.replace('.json', '.png')))\n\n files = list(zip(sorted(imgs_list), sorted(ann_list)))\n assert len(files), f'No images found in {img_dir}'\n print(f'Loaded {len(files)} images from {img_dir}')\n\n return files\n\n\ndef collect_annotations(files, nproc=1):\n \"\"\"Collect the annotation information.\n\n Args:\n files (list): The list of tuples (image_file, groundtruth_file)\n nproc (int): The number of process to collect annotations\n\n Returns:\n images (list): The list of image information dicts\n \"\"\"\n assert isinstance(files, list)\n assert isinstance(nproc, int)\n\n if nproc > 1:\n images = mmcv.track_parallel_progress(\n load_img_info, files, nproc=nproc)\n else:\n images = mmcv.track_progress(load_img_info, files)\n\n return images\n\n\ndef load_img_info(files):\n \"\"\"Load the information of one image.\n\n Args:\n files (tuple): The tuple of (img_file, groundtruth_file)\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n assert isinstance(files, tuple)\n\n img_file, gt_file = files\n assert osp.basename(gt_file).split('.')[0] == osp.basename(img_file).split(\n '.')[0]\n # read imgs while ignoring orientations\n img = mmcv.imread(img_file, 'unchanged')\n\n img_info = dict(\n file_name=osp.join(osp.basename(img_file)),\n height=img.shape[0],\n width=img.shape[1],\n segm_file=osp.join(osp.basename(gt_file)))\n\n if osp.splitext(gt_file)[1] == '.json':\n img_info = load_json_info(gt_file, img_info)\n else:\n raise NotImplementedError\n\n return img_info\n\n\ndef load_json_info(gt_file, img_info):\n \"\"\"Collect the annotation information.\n\n Args:\n gt_file (str): The path to ground-truth\n img_info (dict): The dict of the img and annotation information\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n\n annotation = mmcv.load(gt_file)\n anno_info = []\n for form in annotation['form']:\n for ann in form['words']:\n\n iscrowd = 1 if len(ann['text']) == 0 else 0\n\n x1, y1, x2, y2 = ann['box']\n x = max(0, min(math.floor(x1), math.floor(x2)))\n y = max(0, min(math.floor(y1), math.floor(y2)))\n w, h = math.ceil(abs(x2 - x1)), math.ceil(abs(y2 - y1))\n bbox = [x, y, w, h]\n segmentation = [x, y, x + w, y, x + w, y + h, x, y + h]\n\n anno = dict(\n iscrowd=iscrowd,\n category_id=1,\n bbox=bbox,\n area=w * h,\n segmentation=[segmentation])\n anno_info.append(anno)\n\n img_info.update(anno_info=anno_info)\n\n return img_info\n\n\ndef parse_args():\n parser = argparse.ArgumentParser(\n description='Generate training and test set of FUNSD ')\n parser.add_argument('root_path', help='Root dir path of FUNSD')\n parser.add_argument(\n '--nproc', default=1, type=int, help='Number of process')\n args = parser.parse_args()\n return args\n\n\ndef main():\n args = parse_args()\n root_path = args.root_path\n\n for split in ['training', 'test']:\n print(f'Processing {split} set...')\n with mmcv.Timer(print_tmpl='It takes {}s to convert FUNSD annotation'):\n files = collect_files(\n osp.join(root_path, 'imgs'),\n osp.join(root_path, 'annotations', split))\n image_infos = collect_annotations(files, nproc=args.nproc)\n convert_annotations(\n image_infos, osp.join(root_path,\n 'instances_' + split + '.json'))\n\n\nif __name__ == '__main__':\n main()\n"}}},{"rowIdx":1089,"cells":{"function_name":{"kind":"string","value":"load_img_info"},"docstring":{"kind":"string","value":"Load the information of one image.\n\nArgs:\n files (tuple): The tuple of (img_file, groundtruth_file)\n\nReturns:\n img_info (dict): The dict of the img and annotation information"},"masked_code":{"kind":"string","value":"# Copyright (c) OpenMMLab. All rights reserved.\nimport argparse\nimport math\nimport os\nimport os.path as osp\n\nimport mmcv\n\nfrom mmocr.utils import convert_annotations\n\n\ndef collect_files(img_dir, gt_dir):\n \"\"\"Collect all images and their corresponding groundtruth files.\n\n Args:\n img_dir (str): The image directory\n gt_dir (str): The groundtruth directory\n\n Returns:\n files (list): The list of tuples (img_file, groundtruth_file)\n \"\"\"\n assert isinstance(img_dir, str)\n assert img_dir\n assert isinstance(gt_dir, str)\n assert gt_dir\n\n ann_list, imgs_list = [], []\n for gt_file in os.listdir(gt_dir):\n ann_list.append(osp.join(gt_dir, gt_file))\n imgs_list.append(osp.join(img_dir, gt_file.replace('.json', '.png')))\n\n files = list(zip(sorted(imgs_list), sorted(ann_list)))\n assert len(files), f'No images found in {img_dir}'\n print(f'Loaded {len(files)} images from {img_dir}')\n\n return files\n\n\ndef collect_annotations(files, nproc=1):\n \"\"\"Collect the annotation information.\n\n Args:\n files (list): The list of tuples (image_file, groundtruth_file)\n nproc (int): The number of process to collect annotations\n\n Returns:\n images (list): The list of image information dicts\n \"\"\"\n assert isinstance(files, list)\n assert isinstance(nproc, int)\n\n if nproc > 1:\n images = mmcv.track_parallel_progress(\n load_img_info, files, nproc=nproc)\n else:\n images = mmcv.track_progress(load_img_info, files)\n\n return images\n\n\n# MASKED: load_img_info function (lines 61-89)\n\n\ndef load_json_info(gt_file, img_info):\n \"\"\"Collect the annotation information.\n\n Args:\n gt_file (str): The path to ground-truth\n img_info (dict): The dict of the img and annotation information\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n\n annotation = mmcv.load(gt_file)\n anno_info = []\n for form in annotation['form']:\n for ann in form['words']:\n\n iscrowd = 1 if len(ann['text']) == 0 else 0\n\n x1, y1, x2, y2 = ann['box']\n x = max(0, min(math.floor(x1), math.floor(x2)))\n y = max(0, min(math.floor(y1), math.floor(y2)))\n w, h = math.ceil(abs(x2 - x1)), math.ceil(abs(y2 - y1))\n bbox = [x, y, w, h]\n segmentation = [x, y, x + w, y, x + w, y + h, x, y + h]\n\n anno = dict(\n iscrowd=iscrowd,\n category_id=1,\n bbox=bbox,\n area=w * h,\n segmentation=[segmentation])\n anno_info.append(anno)\n\n img_info.update(anno_info=anno_info)\n\n return img_info\n\n\ndef parse_args():\n parser = argparse.ArgumentParser(\n description='Generate training and test set of FUNSD ')\n parser.add_argument('root_path', help='Root dir path of FUNSD')\n parser.add_argument(\n '--nproc', default=1, type=int, help='Number of process')\n args = parser.parse_args()\n return args\n\n\ndef main():\n args = parse_args()\n root_path = args.root_path\n\n for split in ['training', 'test']:\n print(f'Processing {split} set...')\n with mmcv.Timer(print_tmpl='It takes {}s to convert FUNSD annotation'):\n files = collect_files(\n osp.join(root_path, 'imgs'),\n osp.join(root_path, 'annotations', split))\n image_infos = collect_annotations(files, nproc=args.nproc)\n convert_annotations(\n image_infos, osp.join(root_path,\n 'instances_' + split + '.json'))\n\n\nif __name__ == '__main__':\n main()"},"implementation":{"kind":"string","value":"def load_img_info(files):\n \"\"\"Load the information of one image.\n\n Args:\n files (tuple): The tuple of (img_file, groundtruth_file)\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n assert isinstance(files, tuple)\n\n img_file, gt_file = files\n assert osp.basename(gt_file).split('.')[0] == osp.basename(img_file).split(\n '.')[0]\n # read imgs while ignoring orientations\n img = mmcv.imread(img_file, 'unchanged')\n\n img_info = dict(\n file_name=osp.join(osp.basename(img_file)),\n height=img.shape[0],\n width=img.shape[1],\n segm_file=osp.join(osp.basename(gt_file)))\n\n if osp.splitext(gt_file)[1] == '.json':\n img_info = load_json_info(gt_file, img_info)\n else:\n raise NotImplementedError\n\n return img_info"},"start_line":{"kind":"number","value":61,"string":"61"},"end_line":{"kind":"number","value":89,"string":"89"},"file_content":{"kind":"string","value":"# Copyright (c) OpenMMLab. All rights reserved.\nimport argparse\nimport math\nimport os\nimport os.path as osp\n\nimport mmcv\n\nfrom mmocr.utils import convert_annotations\n\n\ndef collect_files(img_dir, gt_dir):\n \"\"\"Collect all images and their corresponding groundtruth files.\n\n Args:\n img_dir (str): The image directory\n gt_dir (str): The groundtruth directory\n\n Returns:\n files (list): The list of tuples (img_file, groundtruth_file)\n \"\"\"\n assert isinstance(img_dir, str)\n assert img_dir\n assert isinstance(gt_dir, str)\n assert gt_dir\n\n ann_list, imgs_list = [], []\n for gt_file in os.listdir(gt_dir):\n ann_list.append(osp.join(gt_dir, gt_file))\n imgs_list.append(osp.join(img_dir, gt_file.replace('.json', '.png')))\n\n files = list(zip(sorted(imgs_list), sorted(ann_list)))\n assert len(files), f'No images found in {img_dir}'\n print(f'Loaded {len(files)} images from {img_dir}')\n\n return files\n\n\ndef collect_annotations(files, nproc=1):\n \"\"\"Collect the annotation information.\n\n Args:\n files (list): The list of tuples (image_file, groundtruth_file)\n nproc (int): The number of process to collect annotations\n\n Returns:\n images (list): The list of image information dicts\n \"\"\"\n assert isinstance(files, list)\n assert isinstance(nproc, int)\n\n if nproc > 1:\n images = mmcv.track_parallel_progress(\n load_img_info, files, nproc=nproc)\n else:\n images = mmcv.track_progress(load_img_info, files)\n\n return images\n\n\ndef load_img_info(files):\n \"\"\"Load the information of one image.\n\n Args:\n files (tuple): The tuple of (img_file, groundtruth_file)\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n assert isinstance(files, tuple)\n\n img_file, gt_file = files\n assert osp.basename(gt_file).split('.')[0] == osp.basename(img_file).split(\n '.')[0]\n # read imgs while ignoring orientations\n img = mmcv.imread(img_file, 'unchanged')\n\n img_info = dict(\n file_name=osp.join(osp.basename(img_file)),\n height=img.shape[0],\n width=img.shape[1],\n segm_file=osp.join(osp.basename(gt_file)))\n\n if osp.splitext(gt_file)[1] == '.json':\n img_info = load_json_info(gt_file, img_info)\n else:\n raise NotImplementedError\n\n return img_info\n\n\ndef load_json_info(gt_file, img_info):\n \"\"\"Collect the annotation information.\n\n Args:\n gt_file (str): The path to ground-truth\n img_info (dict): The dict of the img and annotation information\n\n Returns:\n img_info (dict): The dict of the img and annotation information\n \"\"\"\n\n annotation = mmcv.load(gt_file)\n anno_info = []\n for form in annotation['form']:\n for ann in form['words']:\n\n iscrowd = 1 if len(ann['text']) == 0 else 0\n\n x1, y1, x2, y2 = ann['box']\n x = max(0, min(math.floor(x1), math.floor(x2)))\n y = max(0, min(math.floor(y1), math.floor(y2)))\n w, h = math.ceil(abs(x2 - x1)), math.ceil(abs(y2 - y1))\n bbox = [x, y, w, h]\n segmentation = [x, y, x + w, y, x + w, y + h, x, y + h]\n\n anno = dict(\n iscrowd=iscrowd,\n category_id=1,\n bbox=bbox,\n area=w * h,\n segmentation=[segmentation])\n anno_info.append(anno)\n\n img_info.update(anno_info=anno_info)\n\n return img_info\n\n\ndef parse_args():\n parser = argparse.ArgumentParser(\n description='Generate training and test set of FUNSD ')\n parser.add_argument('root_path', help='Root dir path of FUNSD')\n parser.add_argument(\n '--nproc', default=1, type=int, help='Number of process')\n args = parser.parse_args()\n return args\n\n\ndef main():\n args = parse_args()\n root_path = args.root_path\n\n for split in ['training', 'test']:\n print(f'Processing {split} set...')\n with mmcv.Timer(print_tmpl='It takes {}s to convert FUNSD annotation'):\n files = collect_files(\n osp.join(root_path, 'imgs'),\n osp.join(root_path, 'annotations', split))\n image_infos = collect_annotations(files, nproc=args.nproc)\n convert_annotations(\n image_infos, osp.join(root_path,\n 'instances_' + split + '.json'))\n\n\nif __name__ == '__main__':\n main()\n"}}},{"rowIdx":1090,"cells":{"function_name":{"kind":"string","value":"get_x_coordinate"},"docstring":{"kind":"string","value":"Given the width of the canvas and the index of the current year\nin the YEARS list, returns the x coordinate of the vertical\nline associated with that year.\n\nInput:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\nReturns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year."},"masked_code":{"kind":"string","value":"\"\"\"\nSC101 Baby Names Project\nAdapted from Nick Parlante's Baby Names assignment by\nJerry Liao.\n\nYOUR DESCRIPTION HERE\n\"\"\"\n\nimport tkinter\nimport babynames\nimport babygraphicsgui as gui\n\nFILENAMES = [\n 'data/full/baby-1900.txt', 'data/full/baby-1910.txt',\n 'data/full/baby-1920.txt', 'data/full/baby-1930.txt',\n 'data/full/baby-1940.txt', 'data/full/baby-1950.txt',\n 'data/full/baby-1960.txt', 'data/full/baby-1970.txt',\n 'data/full/baby-1980.txt', 'data/full/baby-1990.txt',\n 'data/full/baby-2000.txt', 'data/full/baby-2010.txt'\n]\nCANVAS_WIDTH = 1000\nCANVAS_HEIGHT = 600\nYEARS = [1900, 1910, 1920, 1930, 1940, 1950, 1960, 1970, 1980, 1990, 2000, 2010]\nGRAPH_MARGIN_SIZE = 20\nCOLORS = ['red', 'purple', 'green', 'blue']\nTEXT_DX = 2\nLINE_WIDTH = 2\nMAX_RANK = 1000\n\n\n# MASKED: get_x_coordinate function (lines 31-46)\n\n\ndef draw_fixed_lines(canvas):\n \"\"\"\n Erases all existing information on the given canvas and then\n draws the fixed background lines on it.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\n Returns:\n This function does not return any value.\n \"\"\"\n canvas.delete('all') # delete all existing lines from the canvas\n\n # Write your code below this line\n #################################\n\n # horizontal line (upper)\n canvas.create_line(GRAPH_MARGIN_SIZE, GRAPH_MARGIN_SIZE, CANVAS_WIDTH-GRAPH_MARGIN_SIZE,\n GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # horizontal line (bottom)\n canvas.create_line(GRAPH_MARGIN_SIZE, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, CANVAS_WIDTH - GRAPH_MARGIN_SIZE,\n CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # vertical lines\n for i in range(len(YEARS)):\n x = get_x_coordinate(CANVAS_WIDTH, i)\n canvas.create_line(x, 0, x, CANVAS_HEIGHT, width=LINE_WIDTH)\n canvas.create_text(x+TEXT_DX, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, text=YEARS[i],\n anchor=tkinter.NW)\n\n\ndef draw_names(canvas, name_data, lookup_names):\n \"\"\"\n Given a dict of baby name data and a list of name, plots\n the historical trend of those names onto the canvas.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\n Returns:\n This function does not return any value.\n \"\"\"\n draw_fixed_lines(canvas) # draw the fixed background grid\n\n # Write your code below this line\n #################################\n\n # (x_previous, y_previous) represents the rank of the target name in the last year\n x_previous = 0\n y_previous = 0\n\n # draw the trend lines of the target names respectively\n for i in range(len(lookup_names)):\n name = lookup_names[i]\n color = COLORS[i % len(COLORS)] # 使用常數!!\n for j in range(len(YEARS)):\n year = str(YEARS[j])\n # (x, y) represents the rank of the target name in the year\n # x: at the year line\n # y: associated with the rank of the year\n x = get_x_coordinate(CANVAS_WIDTH, j)\n if year in name_data[name]: # the target name is in top 1000 of the year\n rank = int(name_data[name][year])\n y = GRAPH_MARGIN_SIZE + ((CANVAS_HEIGHT-GRAPH_MARGIN_SIZE*2)/MAX_RANK)*(rank-1) # 使用長數\n else: # the target name is not in top 1000 of the year\n rank = '*'\n y = CANVAS_HEIGHT - GRAPH_MARGIN_SIZE\n # add trend lines\n if j != 0:\n canvas.create_line(x_previous, y_previous, x, y, width=LINE_WIDTH, fill=color)\n # add text(name and rank) besides trend lines\n canvas.create_text(x + TEXT_DX, y, text=f'{name} {rank}', anchor=tkinter.SW, fill=color)\n\n # record\n x_previous = x\n y_previous = y\n\n\n# main() code is provided, feel free to read through it but DO NOT MODIFY\ndef main():\n # Load data\n name_data = babynames.read_files(FILENAMES)\n print(name_data)\n\n # Create the window and the canvas\n top = tkinter.Tk()\n top.wm_title('Baby Names')\n canvas = gui.make_gui(top, CANVAS_WIDTH, CANVAS_HEIGHT, name_data, draw_names, babynames.search_names)\n\n # Call draw_fixed_lines() once at startup so we have the lines\n # even before the user types anything.\n draw_fixed_lines(canvas)\n\n # This line starts the graphical loop that is responsible for\n # processing user interactions and plotting data\n top.mainloop()\n\n\nif __name__ == '__main__':\n main()"},"implementation":{"kind":"string","value":"def get_x_coordinate(width, year_index):\n \"\"\"\n Given the width of the canvas and the index of the current year\n in the YEARS list, returns the x coordinate of the vertical\n line associated with that year.\n\n Input:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\n Returns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year.\n \"\"\"\n space = (width - GRAPH_MARGIN_SIZE*2) / len(YEARS) # space between two lines\n x_coordinate = GRAPH_MARGIN_SIZE + year_index * space # x coordinate of the vertical line\n return x_coordinate"},"start_line":{"kind":"number","value":31,"string":"31"},"end_line":{"kind":"number","value":46,"string":"46"},"file_content":{"kind":"string","value":"\"\"\"\nSC101 Baby Names Project\nAdapted from Nick Parlante's Baby Names assignment by\nJerry Liao.\n\nYOUR DESCRIPTION HERE\n\"\"\"\n\nimport tkinter\nimport babynames\nimport babygraphicsgui as gui\n\nFILENAMES = [\n 'data/full/baby-1900.txt', 'data/full/baby-1910.txt',\n 'data/full/baby-1920.txt', 'data/full/baby-1930.txt',\n 'data/full/baby-1940.txt', 'data/full/baby-1950.txt',\n 'data/full/baby-1960.txt', 'data/full/baby-1970.txt',\n 'data/full/baby-1980.txt', 'data/full/baby-1990.txt',\n 'data/full/baby-2000.txt', 'data/full/baby-2010.txt'\n]\nCANVAS_WIDTH = 1000\nCANVAS_HEIGHT = 600\nYEARS = [1900, 1910, 1920, 1930, 1940, 1950, 1960, 1970, 1980, 1990, 2000, 2010]\nGRAPH_MARGIN_SIZE = 20\nCOLORS = ['red', 'purple', 'green', 'blue']\nTEXT_DX = 2\nLINE_WIDTH = 2\nMAX_RANK = 1000\n\n\ndef get_x_coordinate(width, year_index):\n \"\"\"\n Given the width of the canvas and the index of the current year\n in the YEARS list, returns the x coordinate of the vertical\n line associated with that year.\n\n Input:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\n Returns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year.\n \"\"\"\n space = (width - GRAPH_MARGIN_SIZE*2) / len(YEARS) # space between two lines\n x_coordinate = GRAPH_MARGIN_SIZE + year_index * space # x coordinate of the vertical line\n return x_coordinate\n\n\ndef draw_fixed_lines(canvas):\n \"\"\"\n Erases all existing information on the given canvas and then\n draws the fixed background lines on it.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\n Returns:\n This function does not return any value.\n \"\"\"\n canvas.delete('all') # delete all existing lines from the canvas\n\n # Write your code below this line\n #################################\n\n # horizontal line (upper)\n canvas.create_line(GRAPH_MARGIN_SIZE, GRAPH_MARGIN_SIZE, CANVAS_WIDTH-GRAPH_MARGIN_SIZE,\n GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # horizontal line (bottom)\n canvas.create_line(GRAPH_MARGIN_SIZE, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, CANVAS_WIDTH - GRAPH_MARGIN_SIZE,\n CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # vertical lines\n for i in range(len(YEARS)):\n x = get_x_coordinate(CANVAS_WIDTH, i)\n canvas.create_line(x, 0, x, CANVAS_HEIGHT, width=LINE_WIDTH)\n canvas.create_text(x+TEXT_DX, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, text=YEARS[i],\n anchor=tkinter.NW)\n\n\ndef draw_names(canvas, name_data, lookup_names):\n \"\"\"\n Given a dict of baby name data and a list of name, plots\n the historical trend of those names onto the canvas.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\n Returns:\n This function does not return any value.\n \"\"\"\n draw_fixed_lines(canvas) # draw the fixed background grid\n\n # Write your code below this line\n #################################\n\n # (x_previous, y_previous) represents the rank of the target name in the last year\n x_previous = 0\n y_previous = 0\n\n # draw the trend lines of the target names respectively\n for i in range(len(lookup_names)):\n name = lookup_names[i]\n color = COLORS[i % len(COLORS)] # 使用常數!!\n for j in range(len(YEARS)):\n year = str(YEARS[j])\n # (x, y) represents the rank of the target name in the year\n # x: at the year line\n # y: associated with the rank of the year\n x = get_x_coordinate(CANVAS_WIDTH, j)\n if year in name_data[name]: # the target name is in top 1000 of the year\n rank = int(name_data[name][year])\n y = GRAPH_MARGIN_SIZE + ((CANVAS_HEIGHT-GRAPH_MARGIN_SIZE*2)/MAX_RANK)*(rank-1) # 使用長數\n else: # the target name is not in top 1000 of the year\n rank = '*'\n y = CANVAS_HEIGHT - GRAPH_MARGIN_SIZE\n # add trend lines\n if j != 0:\n canvas.create_line(x_previous, y_previous, x, y, width=LINE_WIDTH, fill=color)\n # add text(name and rank) besides trend lines\n canvas.create_text(x + TEXT_DX, y, text=f'{name} {rank}', anchor=tkinter.SW, fill=color)\n\n # record\n x_previous = x\n y_previous = y\n\n\n# main() code is provided, feel free to read through it but DO NOT MODIFY\ndef main():\n # Load data\n name_data = babynames.read_files(FILENAMES)\n print(name_data)\n\n # Create the window and the canvas\n top = tkinter.Tk()\n top.wm_title('Baby Names')\n canvas = gui.make_gui(top, CANVAS_WIDTH, CANVAS_HEIGHT, name_data, draw_names, babynames.search_names)\n\n # Call draw_fixed_lines() once at startup so we have the lines\n # even before the user types anything.\n draw_fixed_lines(canvas)\n\n # This line starts the graphical loop that is responsible for\n # processing user interactions and plotting data\n top.mainloop()\n\n\nif __name__ == '__main__':\n main()\n"}}},{"rowIdx":1091,"cells":{"function_name":{"kind":"string","value":"draw_fixed_lines"},"docstring":{"kind":"string","value":"Erases all existing information on the given canvas and then\ndraws the fixed background lines on it.\n\nInput:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\nReturns:\n This function does not return any value."},"masked_code":{"kind":"string","value":"\"\"\"\nSC101 Baby Names Project\nAdapted from Nick Parlante's Baby Names assignment by\nJerry Liao.\n\nYOUR DESCRIPTION HERE\n\"\"\"\n\nimport tkinter\nimport babynames\nimport babygraphicsgui as gui\n\nFILENAMES = [\n 'data/full/baby-1900.txt', 'data/full/baby-1910.txt',\n 'data/full/baby-1920.txt', 'data/full/baby-1930.txt',\n 'data/full/baby-1940.txt', 'data/full/baby-1950.txt',\n 'data/full/baby-1960.txt', 'data/full/baby-1970.txt',\n 'data/full/baby-1980.txt', 'data/full/baby-1990.txt',\n 'data/full/baby-2000.txt', 'data/full/baby-2010.txt'\n]\nCANVAS_WIDTH = 1000\nCANVAS_HEIGHT = 600\nYEARS = [1900, 1910, 1920, 1930, 1940, 1950, 1960, 1970, 1980, 1990, 2000, 2010]\nGRAPH_MARGIN_SIZE = 20\nCOLORS = ['red', 'purple', 'green', 'blue']\nTEXT_DX = 2\nLINE_WIDTH = 2\nMAX_RANK = 1000\n\n\ndef get_x_coordinate(width, year_index):\n \"\"\"\n Given the width of the canvas and the index of the current year\n in the YEARS list, returns the x coordinate of the vertical\n line associated with that year.\n\n Input:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\n Returns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year.\n \"\"\"\n space = (width - GRAPH_MARGIN_SIZE*2) / len(YEARS) # space between two lines\n x_coordinate = GRAPH_MARGIN_SIZE + year_index * space # x coordinate of the vertical line\n return x_coordinate\n\n\n# MASKED: draw_fixed_lines function (lines 49-76)\n\n\ndef draw_names(canvas, name_data, lookup_names):\n \"\"\"\n Given a dict of baby name data and a list of name, plots\n the historical trend of those names onto the canvas.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\n Returns:\n This function does not return any value.\n \"\"\"\n draw_fixed_lines(canvas) # draw the fixed background grid\n\n # Write your code below this line\n #################################\n\n # (x_previous, y_previous) represents the rank of the target name in the last year\n x_previous = 0\n y_previous = 0\n\n # draw the trend lines of the target names respectively\n for i in range(len(lookup_names)):\n name = lookup_names[i]\n color = COLORS[i % len(COLORS)] # 使用常數!!\n for j in range(len(YEARS)):\n year = str(YEARS[j])\n # (x, y) represents the rank of the target name in the year\n # x: at the year line\n # y: associated with the rank of the year\n x = get_x_coordinate(CANVAS_WIDTH, j)\n if year in name_data[name]: # the target name is in top 1000 of the year\n rank = int(name_data[name][year])\n y = GRAPH_MARGIN_SIZE + ((CANVAS_HEIGHT-GRAPH_MARGIN_SIZE*2)/MAX_RANK)*(rank-1) # 使用長數\n else: # the target name is not in top 1000 of the year\n rank = '*'\n y = CANVAS_HEIGHT - GRAPH_MARGIN_SIZE\n # add trend lines\n if j != 0:\n canvas.create_line(x_previous, y_previous, x, y, width=LINE_WIDTH, fill=color)\n # add text(name and rank) besides trend lines\n canvas.create_text(x + TEXT_DX, y, text=f'{name} {rank}', anchor=tkinter.SW, fill=color)\n\n # record\n x_previous = x\n y_previous = y\n\n\n# main() code is provided, feel free to read through it but DO NOT MODIFY\ndef main():\n # Load data\n name_data = babynames.read_files(FILENAMES)\n print(name_data)\n\n # Create the window and the canvas\n top = tkinter.Tk()\n top.wm_title('Baby Names')\n canvas = gui.make_gui(top, CANVAS_WIDTH, CANVAS_HEIGHT, name_data, draw_names, babynames.search_names)\n\n # Call draw_fixed_lines() once at startup so we have the lines\n # even before the user types anything.\n draw_fixed_lines(canvas)\n\n # This line starts the graphical loop that is responsible for\n # processing user interactions and plotting data\n top.mainloop()\n\n\nif __name__ == '__main__':\n main()"},"implementation":{"kind":"string","value":"def draw_fixed_lines(canvas):\n \"\"\"\n Erases all existing information on the given canvas and then\n draws the fixed background lines on it.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\n Returns:\n This function does not return any value.\n \"\"\"\n canvas.delete('all') # delete all existing lines from the canvas\n\n # Write your code below this line\n #################################\n\n # horizontal line (upper)\n canvas.create_line(GRAPH_MARGIN_SIZE, GRAPH_MARGIN_SIZE, CANVAS_WIDTH-GRAPH_MARGIN_SIZE,\n GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # horizontal line (bottom)\n canvas.create_line(GRAPH_MARGIN_SIZE, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, CANVAS_WIDTH - GRAPH_MARGIN_SIZE,\n CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # vertical lines\n for i in range(len(YEARS)):\n x = get_x_coordinate(CANVAS_WIDTH, i)\n canvas.create_line(x, 0, x, CANVAS_HEIGHT, width=LINE_WIDTH)\n canvas.create_text(x+TEXT_DX, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, text=YEARS[i],\n anchor=tkinter.NW)"},"start_line":{"kind":"number","value":49,"string":"49"},"end_line":{"kind":"number","value":76,"string":"76"},"file_content":{"kind":"string","value":"\"\"\"\nSC101 Baby Names Project\nAdapted from Nick Parlante's Baby Names assignment by\nJerry Liao.\n\nYOUR DESCRIPTION HERE\n\"\"\"\n\nimport tkinter\nimport babynames\nimport babygraphicsgui as gui\n\nFILENAMES = [\n 'data/full/baby-1900.txt', 'data/full/baby-1910.txt',\n 'data/full/baby-1920.txt', 'data/full/baby-1930.txt',\n 'data/full/baby-1940.txt', 'data/full/baby-1950.txt',\n 'data/full/baby-1960.txt', 'data/full/baby-1970.txt',\n 'data/full/baby-1980.txt', 'data/full/baby-1990.txt',\n 'data/full/baby-2000.txt', 'data/full/baby-2010.txt'\n]\nCANVAS_WIDTH = 1000\nCANVAS_HEIGHT = 600\nYEARS = [1900, 1910, 1920, 1930, 1940, 1950, 1960, 1970, 1980, 1990, 2000, 2010]\nGRAPH_MARGIN_SIZE = 20\nCOLORS = ['red', 'purple', 'green', 'blue']\nTEXT_DX = 2\nLINE_WIDTH = 2\nMAX_RANK = 1000\n\n\ndef get_x_coordinate(width, year_index):\n \"\"\"\n Given the width of the canvas and the index of the current year\n in the YEARS list, returns the x coordinate of the vertical\n line associated with that year.\n\n Input:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\n Returns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year.\n \"\"\"\n space = (width - GRAPH_MARGIN_SIZE*2) / len(YEARS) # space between two lines\n x_coordinate = GRAPH_MARGIN_SIZE + year_index * space # x coordinate of the vertical line\n return x_coordinate\n\n\ndef draw_fixed_lines(canvas):\n \"\"\"\n Erases all existing information on the given canvas and then\n draws the fixed background lines on it.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\n Returns:\n This function does not return any value.\n \"\"\"\n canvas.delete('all') # delete all existing lines from the canvas\n\n # Write your code below this line\n #################################\n\n # horizontal line (upper)\n canvas.create_line(GRAPH_MARGIN_SIZE, GRAPH_MARGIN_SIZE, CANVAS_WIDTH-GRAPH_MARGIN_SIZE,\n GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # horizontal line (bottom)\n canvas.create_line(GRAPH_MARGIN_SIZE, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, CANVAS_WIDTH - GRAPH_MARGIN_SIZE,\n CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # vertical lines\n for i in range(len(YEARS)):\n x = get_x_coordinate(CANVAS_WIDTH, i)\n canvas.create_line(x, 0, x, CANVAS_HEIGHT, width=LINE_WIDTH)\n canvas.create_text(x+TEXT_DX, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, text=YEARS[i],\n anchor=tkinter.NW)\n\n\ndef draw_names(canvas, name_data, lookup_names):\n \"\"\"\n Given a dict of baby name data and a list of name, plots\n the historical trend of those names onto the canvas.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\n Returns:\n This function does not return any value.\n \"\"\"\n draw_fixed_lines(canvas) # draw the fixed background grid\n\n # Write your code below this line\n #################################\n\n # (x_previous, y_previous) represents the rank of the target name in the last year\n x_previous = 0\n y_previous = 0\n\n # draw the trend lines of the target names respectively\n for i in range(len(lookup_names)):\n name = lookup_names[i]\n color = COLORS[i % len(COLORS)] # 使用常數!!\n for j in range(len(YEARS)):\n year = str(YEARS[j])\n # (x, y) represents the rank of the target name in the year\n # x: at the year line\n # y: associated with the rank of the year\n x = get_x_coordinate(CANVAS_WIDTH, j)\n if year in name_data[name]: # the target name is in top 1000 of the year\n rank = int(name_data[name][year])\n y = GRAPH_MARGIN_SIZE + ((CANVAS_HEIGHT-GRAPH_MARGIN_SIZE*2)/MAX_RANK)*(rank-1) # 使用長數\n else: # the target name is not in top 1000 of the year\n rank = '*'\n y = CANVAS_HEIGHT - GRAPH_MARGIN_SIZE\n # add trend lines\n if j != 0:\n canvas.create_line(x_previous, y_previous, x, y, width=LINE_WIDTH, fill=color)\n # add text(name and rank) besides trend lines\n canvas.create_text(x + TEXT_DX, y, text=f'{name} {rank}', anchor=tkinter.SW, fill=color)\n\n # record\n x_previous = x\n y_previous = y\n\n\n# main() code is provided, feel free to read through it but DO NOT MODIFY\ndef main():\n # Load data\n name_data = babynames.read_files(FILENAMES)\n print(name_data)\n\n # Create the window and the canvas\n top = tkinter.Tk()\n top.wm_title('Baby Names')\n canvas = gui.make_gui(top, CANVAS_WIDTH, CANVAS_HEIGHT, name_data, draw_names, babynames.search_names)\n\n # Call draw_fixed_lines() once at startup so we have the lines\n # even before the user types anything.\n draw_fixed_lines(canvas)\n\n # This line starts the graphical loop that is responsible for\n # processing user interactions and plotting data\n top.mainloop()\n\n\nif __name__ == '__main__':\n main()\n"}}},{"rowIdx":1092,"cells":{"function_name":{"kind":"string","value":"draw_names"},"docstring":{"kind":"string","value":"Given a dict of baby name data and a list of name, plots\nthe historical trend of those names onto the canvas.\n\nInput:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\nReturns:\n This function does not return any value."},"masked_code":{"kind":"string","value":"\"\"\"\nSC101 Baby Names Project\nAdapted from Nick Parlante's Baby Names assignment by\nJerry Liao.\n\nYOUR DESCRIPTION HERE\n\"\"\"\n\nimport tkinter\nimport babynames\nimport babygraphicsgui as gui\n\nFILENAMES = [\n 'data/full/baby-1900.txt', 'data/full/baby-1910.txt',\n 'data/full/baby-1920.txt', 'data/full/baby-1930.txt',\n 'data/full/baby-1940.txt', 'data/full/baby-1950.txt',\n 'data/full/baby-1960.txt', 'data/full/baby-1970.txt',\n 'data/full/baby-1980.txt', 'data/full/baby-1990.txt',\n 'data/full/baby-2000.txt', 'data/full/baby-2010.txt'\n]\nCANVAS_WIDTH = 1000\nCANVAS_HEIGHT = 600\nYEARS = [1900, 1910, 1920, 1930, 1940, 1950, 1960, 1970, 1980, 1990, 2000, 2010]\nGRAPH_MARGIN_SIZE = 20\nCOLORS = ['red', 'purple', 'green', 'blue']\nTEXT_DX = 2\nLINE_WIDTH = 2\nMAX_RANK = 1000\n\n\ndef get_x_coordinate(width, year_index):\n \"\"\"\n Given the width of the canvas and the index of the current year\n in the YEARS list, returns the x coordinate of the vertical\n line associated with that year.\n\n Input:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\n Returns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year.\n \"\"\"\n space = (width - GRAPH_MARGIN_SIZE*2) / len(YEARS) # space between two lines\n x_coordinate = GRAPH_MARGIN_SIZE + year_index * space # x coordinate of the vertical line\n return x_coordinate\n\n\ndef draw_fixed_lines(canvas):\n \"\"\"\n Erases all existing information on the given canvas and then\n draws the fixed background lines on it.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\n Returns:\n This function does not return any value.\n \"\"\"\n canvas.delete('all') # delete all existing lines from the canvas\n\n # Write your code below this line\n #################################\n\n # horizontal line (upper)\n canvas.create_line(GRAPH_MARGIN_SIZE, GRAPH_MARGIN_SIZE, CANVAS_WIDTH-GRAPH_MARGIN_SIZE,\n GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # horizontal line (bottom)\n canvas.create_line(GRAPH_MARGIN_SIZE, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, CANVAS_WIDTH - GRAPH_MARGIN_SIZE,\n CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # vertical lines\n for i in range(len(YEARS)):\n x = get_x_coordinate(CANVAS_WIDTH, i)\n canvas.create_line(x, 0, x, CANVAS_HEIGHT, width=LINE_WIDTH)\n canvas.create_text(x+TEXT_DX, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, text=YEARS[i],\n anchor=tkinter.NW)\n\n\n# MASKED: draw_names function (lines 79-125)\n\n\n# main() code is provided, feel free to read through it but DO NOT MODIFY\ndef main():\n # Load data\n name_data = babynames.read_files(FILENAMES)\n print(name_data)\n\n # Create the window and the canvas\n top = tkinter.Tk()\n top.wm_title('Baby Names')\n canvas = gui.make_gui(top, CANVAS_WIDTH, CANVAS_HEIGHT, name_data, draw_names, babynames.search_names)\n\n # Call draw_fixed_lines() once at startup so we have the lines\n # even before the user types anything.\n draw_fixed_lines(canvas)\n\n # This line starts the graphical loop that is responsible for\n # processing user interactions and plotting data\n top.mainloop()\n\n\nif __name__ == '__main__':\n main()"},"implementation":{"kind":"string","value":"def draw_names(canvas, name_data, lookup_names):\n \"\"\"\n Given a dict of baby name data and a list of name, plots\n the historical trend of those names onto the canvas.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\n Returns:\n This function does not return any value.\n \"\"\"\n draw_fixed_lines(canvas) # draw the fixed background grid\n\n # Write your code below this line\n #################################\n\n # (x_previous, y_previous) represents the rank of the target name in the last year\n x_previous = 0\n y_previous = 0\n\n # draw the trend lines of the target names respectively\n for i in range(len(lookup_names)):\n name = lookup_names[i]\n color = COLORS[i % len(COLORS)] # 使用常數!!\n for j in range(len(YEARS)):\n year = str(YEARS[j])\n # (x, y) represents the rank of the target name in the year\n # x: at the year line\n # y: associated with the rank of the year\n x = get_x_coordinate(CANVAS_WIDTH, j)\n if year in name_data[name]: # the target name is in top 1000 of the year\n rank = int(name_data[name][year])\n y = GRAPH_MARGIN_SIZE + ((CANVAS_HEIGHT-GRAPH_MARGIN_SIZE*2)/MAX_RANK)*(rank-1) # 使用長數\n else: # the target name is not in top 1000 of the year\n rank = '*'\n y = CANVAS_HEIGHT - GRAPH_MARGIN_SIZE\n # add trend lines\n if j != 0:\n canvas.create_line(x_previous, y_previous, x, y, width=LINE_WIDTH, fill=color)\n # add text(name and rank) besides trend lines\n canvas.create_text(x + TEXT_DX, y, text=f'{name} {rank}', anchor=tkinter.SW, fill=color)\n\n # record\n x_previous = x\n y_previous = y"},"start_line":{"kind":"number","value":79,"string":"79"},"end_line":{"kind":"number","value":125,"string":"125"},"file_content":{"kind":"string","value":"\"\"\"\nSC101 Baby Names Project\nAdapted from Nick Parlante's Baby Names assignment by\nJerry Liao.\n\nYOUR DESCRIPTION HERE\n\"\"\"\n\nimport tkinter\nimport babynames\nimport babygraphicsgui as gui\n\nFILENAMES = [\n 'data/full/baby-1900.txt', 'data/full/baby-1910.txt',\n 'data/full/baby-1920.txt', 'data/full/baby-1930.txt',\n 'data/full/baby-1940.txt', 'data/full/baby-1950.txt',\n 'data/full/baby-1960.txt', 'data/full/baby-1970.txt',\n 'data/full/baby-1980.txt', 'data/full/baby-1990.txt',\n 'data/full/baby-2000.txt', 'data/full/baby-2010.txt'\n]\nCANVAS_WIDTH = 1000\nCANVAS_HEIGHT = 600\nYEARS = [1900, 1910, 1920, 1930, 1940, 1950, 1960, 1970, 1980, 1990, 2000, 2010]\nGRAPH_MARGIN_SIZE = 20\nCOLORS = ['red', 'purple', 'green', 'blue']\nTEXT_DX = 2\nLINE_WIDTH = 2\nMAX_RANK = 1000\n\n\ndef get_x_coordinate(width, year_index):\n \"\"\"\n Given the width of the canvas and the index of the current year\n in the YEARS list, returns the x coordinate of the vertical\n line associated with that year.\n\n Input:\n width (int): The width of the canvas\n year_index (int): The index of the current year in the YEARS list\n Returns:\n x_coordinate (int): The x coordinate of the vertical line associated\n with the specified year.\n \"\"\"\n space = (width - GRAPH_MARGIN_SIZE*2) / len(YEARS) # space between two lines\n x_coordinate = GRAPH_MARGIN_SIZE + year_index * space # x coordinate of the vertical line\n return x_coordinate\n\n\ndef draw_fixed_lines(canvas):\n \"\"\"\n Erases all existing information on the given canvas and then\n draws the fixed background lines on it.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n\n Returns:\n This function does not return any value.\n \"\"\"\n canvas.delete('all') # delete all existing lines from the canvas\n\n # Write your code below this line\n #################################\n\n # horizontal line (upper)\n canvas.create_line(GRAPH_MARGIN_SIZE, GRAPH_MARGIN_SIZE, CANVAS_WIDTH-GRAPH_MARGIN_SIZE,\n GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # horizontal line (bottom)\n canvas.create_line(GRAPH_MARGIN_SIZE, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, CANVAS_WIDTH - GRAPH_MARGIN_SIZE,\n CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, width=LINE_WIDTH)\n # vertical lines\n for i in range(len(YEARS)):\n x = get_x_coordinate(CANVAS_WIDTH, i)\n canvas.create_line(x, 0, x, CANVAS_HEIGHT, width=LINE_WIDTH)\n canvas.create_text(x+TEXT_DX, CANVAS_HEIGHT - GRAPH_MARGIN_SIZE, text=YEARS[i],\n anchor=tkinter.NW)\n\n\ndef draw_names(canvas, name_data, lookup_names):\n \"\"\"\n Given a dict of baby name data and a list of name, plots\n the historical trend of those names onto the canvas.\n\n Input:\n canvas (Tkinter Canvas): The canvas on which we are drawing.\n name_data (dict): Dictionary holding baby name data\n lookup_names (List[str]): A list of names whose data you want to plot\n\n Returns:\n This function does not return any value.\n \"\"\"\n draw_fixed_lines(canvas) # draw the fixed background grid\n\n # Write your code below this line\n #################################\n\n # (x_previous, y_previous) represents the rank of the target name in the last year\n x_previous = 0\n y_previous = 0\n\n # draw the trend lines of the target names respectively\n for i in range(len(lookup_names)):\n name = lookup_names[i]\n color = COLORS[i % len(COLORS)] # 使用常數!!\n for j in range(len(YEARS)):\n year = str(YEARS[j])\n # (x, y) represents the rank of the target name in the year\n # x: at the year line\n # y: associated with the rank of the year\n x = get_x_coordinate(CANVAS_WIDTH, j)\n if year in name_data[name]: # the target name is in top 1000 of the year\n rank = int(name_data[name][year])\n y = GRAPH_MARGIN_SIZE + ((CANVAS_HEIGHT-GRAPH_MARGIN_SIZE*2)/MAX_RANK)*(rank-1) # 使用長數\n else: # the target name is not in top 1000 of the year\n rank = '*'\n y = CANVAS_HEIGHT - GRAPH_MARGIN_SIZE\n # add trend lines\n if j != 0:\n canvas.create_line(x_previous, y_previous, x, y, width=LINE_WIDTH, fill=color)\n # add text(name and rank) besides trend lines\n canvas.create_text(x + TEXT_DX, y, text=f'{name} {rank}', anchor=tkinter.SW, fill=color)\n\n # record\n x_previous = x\n y_previous = y\n\n\n# main() code is provided, feel free to read through it but DO NOT MODIFY\ndef main():\n # Load data\n name_data = babynames.read_files(FILENAMES)\n print(name_data)\n\n # Create the window and the canvas\n top = tkinter.Tk()\n top.wm_title('Baby Names')\n canvas = gui.make_gui(top, CANVAS_WIDTH, CANVAS_HEIGHT, name_data, draw_names, babynames.search_names)\n\n # Call draw_fixed_lines() once at startup so we have the lines\n # even before the user types anything.\n draw_fixed_lines(canvas)\n\n # This line starts the graphical loop that is responsible for\n # processing user interactions and plotting data\n top.mainloop()\n\n\nif __name__ == '__main__':\n main()\n"}}},{"rowIdx":1093,"cells":{"function_name":{"kind":"string","value":"nick"},"docstring":{"kind":"string","value":"Change an entity's nick name in a MUC room.\n\nSee: http://xmpp.org/extensions/xep-0045.html#changenick\n\n@param roomJID: The JID of the room.\n@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n@param nick: The new nick name within the room.\n@type nick: C{unicode}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n# MASKED: nick function (lines 617-631)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)"},"start_line":{"kind":"number","value":617,"string":"617"},"end_line":{"kind":"number","value":631,"string":"631"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}},{"rowIdx":1094,"cells":{"function_name":{"kind":"string","value":"status"},"docstring":{"kind":"string","value":"Change user status.\n\nSee: http://xmpp.org/extensions/xep-0045.html#changepres\n\n@param roomJID: The Room JID of the room.\n@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n@param show: The availability of the entity. Common values are xa,\n available, etc\n@type show: C{unicode}\n\n@param status: The current status of the entity.\n@type status: C{unicode}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n# MASKED: status function (lines 634-653)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)"},"start_line":{"kind":"number","value":634,"string":"634"},"end_line":{"kind":"number","value":653,"string":"653"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}},{"rowIdx":1095,"cells":{"function_name":{"kind":"string","value":"leave"},"docstring":{"kind":"string","value":"Leave a MUC room.\n\nSee: http://xmpp.org/extensions/xep-0045.html#exit\n\n@param roomJID: The JID of the room.\n@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n# MASKED: leave function (lines 656-669)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)"},"start_line":{"kind":"number","value":656,"string":"656"},"end_line":{"kind":"number","value":669,"string":"669"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}},{"rowIdx":1096,"cells":{"function_name":{"kind":"string","value":"getRegisterForm"},"docstring":{"kind":"string","value":"Grab the registration form for a MUC room.\n\n@param room: The room jabber/xmpp entity id for the requested\n registration form.\n@type room: L{JID<twisted.words.protocols.jabber.jid.JID>}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n# MASKED: getRegisterForm function (lines 729-744)\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d"},"start_line":{"kind":"number","value":729,"string":"729"},"end_line":{"kind":"number","value":744,"string":"744"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}},{"rowIdx":1097,"cells":{"function_name":{"kind":"string","value":"register"},"docstring":{"kind":"string","value":"Send a request to register for a room.\n\n@param roomJID: The bare JID of the room.\n@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n@param options: A mapping of field names to values, or C{None} to\n cancel.\n@type options: C{dict}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n# MASKED: register function (lines 747-761)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)"},"start_line":{"kind":"number","value":747,"string":"747"},"end_line":{"kind":"number","value":761,"string":"761"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}},{"rowIdx":1098,"cells":{"function_name":{"kind":"string","value":"configure"},"docstring":{"kind":"string","value":"Configure a room.\n\n@param roomJID: The room to configure.\n@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n@param options: A mapping of field names to values, or C{None} to\n cancel.\n@type options: C{dict}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n# MASKED: configure function (lines 834-848)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)"},"start_line":{"kind":"number","value":834,"string":"834"},"end_line":{"kind":"number","value":848,"string":"848"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}},{"rowIdx":1099,"cells":{"function_name":{"kind":"string","value":"modifyAffiliationList"},"docstring":{"kind":"string","value":"Modify an affiliation list.\n\n@param roomJID: The bare JID of the room.\n@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n@param entities: The list of entities to change for a room.\n@type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n@param affiliation: The affilation to the entities will acquire.\n@type affiliation: C{unicode}\n\n@param sender: The entity sending the request.\n@type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}"},"masked_code":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n# MASKED: modifyAffiliationList function (lines 956-980)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d"},"implementation":{"kind":"string","value":" def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)"},"start_line":{"kind":"number","value":956,"string":"956"},"end_line":{"kind":"number","value":980,"string":"980"},"file_content":{"kind":"string","value":"# -*- test-case-name: wokkel.test.test_muc -*-\n#\n# Copyright (c) Ralph Meijer.\n# See LICENSE for details.\n\n\"\"\"\nXMPP Multi-User Chat protocol.\n\nThis protocol is specified in\nU{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.\n\"\"\"\nfrom dateutil.tz import tzutc\n\nfrom zope.interface import implements\n\nfrom twisted.internet import defer\nfrom twisted.words.protocols.jabber import jid, error, xmlstream\nfrom twisted.words.xish import domish\n\nfrom wokkel import data_form, generic, iwokkel, xmppim\nfrom wokkel.compat import Values, ValueConstant\nfrom wokkel.delay import Delay, DelayMixin\nfrom wokkel.subprotocols import XMPPHandler\nfrom wokkel.iwokkel import IMUCClient\n\n# Multi User Chat namespaces\nNS_MUC = 'http://jabber.org/protocol/muc'\nNS_MUC_USER = NS_MUC + '#user'\nNS_MUC_ADMIN = NS_MUC + '#admin'\nNS_MUC_OWNER = NS_MUC + '#owner'\nNS_MUC_ROOMINFO = NS_MUC + '#roominfo'\nNS_MUC_CONFIG = NS_MUC + '#roomconfig'\nNS_MUC_REQUEST = NS_MUC + '#request'\nNS_MUC_REGISTER = NS_MUC + '#register'\n\nNS_REGISTER = 'jabber:iq:register'\n\nMESSAGE = '/message'\nPRESENCE = '/presence'\n\nGROUPCHAT = MESSAGE +'[@type=\"groupchat\"]'\n\nDEFER_TIMEOUT = 30 # basic timeout is 30 seconds\n\nclass STATUS_CODE(Values):\n REALJID_PUBLIC = ValueConstant(100)\n AFFILIATION_CHANGED = ValueConstant(101)\n UNAVAILABLE_SHOWN = ValueConstant(102)\n UNAVAILABLE_NOT_SHOWN = ValueConstant(103)\n CONFIGURATION_CHANGED = ValueConstant(104)\n SELF_PRESENCE = ValueConstant(110)\n LOGGING_ENABLED = ValueConstant(170)\n LOGGING_DISABLED = ValueConstant(171)\n NON_ANONYMOUS = ValueConstant(172)\n SEMI_ANONYMOUS = ValueConstant(173)\n FULLY_ANONYMOUS = ValueConstant(174)\n ROOM_CREATED = ValueConstant(201)\n NICK_ASSIGNED = ValueConstant(210)\n BANNED = ValueConstant(301)\n NEW_NICK = ValueConstant(303)\n KICKED = ValueConstant(307)\n REMOVED_AFFILIATION = ValueConstant(321)\n REMOVED_MEMBERSHIP = ValueConstant(322)\n REMOVED_SHUTDOWN = ValueConstant(332)\n\n\nclass Statuses(set):\n \"\"\"\n Container of MUC status conditions.\n\n This is currently implemented as a set of constant values from\n L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that\n defines the supported operations. Even though this class currently derives\n from C{set}, future versions might not. This provides an upgrade path to\n cater for extensible status conditions, as defined in\n U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.\n \"\"\"\n implements(iwokkel.IMUCStatuses)\n\n\n\nclass _FormRequest(generic.Request):\n \"\"\"\n Base class for form exchange requests.\n \"\"\"\n requestNamespace = None\n formNamespace = None\n\n def __init__(self, recipient, sender=None, options=None):\n if options is None:\n stanzaType = 'get'\n else:\n stanzaType = 'set'\n\n generic.Request.__init__(self, recipient, sender, stanzaType)\n self.options = options\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n\n query = element.addElement((self.requestNamespace, 'query'))\n if self.options is None:\n # This is a request for the configuration form.\n form = None\n elif self.options is False:\n form = data_form.Form(formType='cancel')\n else:\n form = data_form.Form(formType='submit',\n formNamespace=self.formNamespace)\n form.makeFields(self.options)\n\n if form is not None:\n query.addChild(form.toElement())\n\n return element\n\n\n\nclass ConfigureRequest(_FormRequest):\n \"\"\"\n Configure MUC room request.\n\n http://xmpp.org/extensions/xep-0045.html#roomconfig\n \"\"\"\n\n requestNamespace = NS_MUC_OWNER\n formNamespace = NS_MUC_CONFIG\n\n\n\nclass RegisterRequest(_FormRequest):\n \"\"\"\n Register request.\n\n http://xmpp.org/extensions/xep-0045.html#register\n \"\"\"\n\n requestNamespace = NS_REGISTER\n formNamespace = NS_MUC_REGISTER\n\n\n\nclass AdminItem(object):\n \"\"\"\n Item representing role and/or affiliation for admin request.\n \"\"\"\n\n def __init__(self, affiliation=None, role=None, entity=None, nick=None,\n reason=None):\n self.affiliation = affiliation\n self.role = role\n self.entity = entity\n self.nick = nick\n self.reason = reason\n\n\n def toElement(self):\n element = domish.Element((NS_MUC_ADMIN, 'item'))\n\n if self.entity:\n element['jid'] = self.entity.full()\n\n if self.nick:\n element['nick'] = self.nick\n\n if self.affiliation:\n element['affiliation'] = self.affiliation\n\n if self.role:\n element['role'] = self.role\n\n if self.reason:\n element.addElement('reason', content=self.reason)\n\n return element\n\n\n @classmethod\n def fromElement(Class, element):\n item = Class()\n\n if element.hasAttribute('jid'):\n item.entity = jid.JID(element['jid'])\n\n item.nick = element.getAttribute('nick')\n item.affiliation = element.getAttribute('affiliation')\n item.role = element.getAttribute('role')\n\n for child in element.elements(NS_MUC_ADMIN, 'reason'):\n item.reason = unicode(child)\n\n return item\n\n\n\nclass AdminStanza(generic.Request):\n \"\"\"\n An admin request or response.\n \"\"\"\n\n childParsers = {(NS_MUC_ADMIN, 'query'): '_childParser_query'}\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_ADMIN, 'query'))\n\n if self.items:\n for item in self.items:\n element.query.addChild(item.toElement())\n\n return element\n\n\n def _childParser_query(self, element):\n self.items = []\n for child in element.elements(NS_MUC_ADMIN, 'item'):\n self.items.append(AdminItem.fromElement(child))\n\n\n\nclass DestructionRequest(generic.Request):\n \"\"\"\n Room destruction request.\n\n @param reason: Optional reason for the destruction of this room.\n @type reason: C{unicode}.\n\n @param alternate: Optional room JID of an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param password: Optional password for entering the alternate venue.\n @type password: C{unicode}\n \"\"\"\n\n stanzaType = 'set'\n\n def __init__(self, recipient, sender=None, reason=None, alternate=None,\n password=None):\n generic.Request.__init__(self, recipient, sender)\n self.reason = reason\n self.alternate = alternate\n self.password = password\n\n\n def toElement(self):\n element = generic.Request.toElement(self)\n element.addElement((NS_MUC_OWNER, 'query'))\n element.query.addElement('destroy')\n\n if self.alternate:\n element.query.destroy['jid'] = self.alternate.full()\n\n if self.password:\n element.query.destroy.addElement('password',\n content=self.password)\n\n if self.reason:\n element.query.destroy.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass GroupChat(xmppim.Message, DelayMixin):\n \"\"\"\n A groupchat message.\n \"\"\"\n\n stanzaType = 'groupchat'\n\n def toElement(self, legacyDelay=False):\n \"\"\"\n Render into a domish Element.\n\n @param legacyDelay: If C{True} send the delayed delivery information\n in legacy format.\n \"\"\"\n element = xmppim.Message.toElement(self)\n\n if self.delay:\n element.addChild(self.delay.toElement(legacy=legacyDelay))\n\n return element\n\n\n\nclass PrivateChat(xmppim.Message):\n \"\"\"\n A chat message.\n \"\"\"\n\n stanzaType = 'chat'\n\n\n\nclass InviteMessage(xmppim.Message):\n\n def __init__(self, recipient=None, sender=None, invitee=None, reason=None):\n xmppim.Message.__init__(self, recipient, sender)\n self.invitee = invitee\n self.reason = reason\n\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n child = element.addElement((NS_MUC_USER, 'x'))\n child.addElement('invite')\n child.invite['to'] = self.invitee.full()\n\n if self.reason:\n child.invite.addElement('reason', content=self.reason)\n\n return element\n\n\n\nclass HistoryOptions(object):\n \"\"\"\n A history configuration object.\n\n @ivar maxchars: Limit the total number of characters in the history to \"X\"\n (where the character count is the characters of the complete XML\n stanzas, not only their XML character data).\n @type maxchars: C{int}\n\n @ivar maxstanzas: Limit the total number of messages in the history to \"X\".\n @type mazstanzas: C{int}\n\n @ivar seconds: Send only the messages received in the last \"X\" seconds.\n @type seconds: C{int}\n\n @ivar since: Send only the messages received since the datetime specified.\n Note that this must be an offset-aware instance.\n @type since: L{datetime.datetime}\n \"\"\"\n attributes = ['maxChars', 'maxStanzas', 'seconds', 'since']\n\n def __init__(self, maxChars=None, maxStanzas=None, seconds=None,\n since=None):\n self.maxChars = maxChars\n self.maxStanzas = maxStanzas\n self.seconds = seconds\n self.since = since\n\n\n def toElement(self):\n \"\"\"\n Returns a L{domish.Element} representing the history options.\n \"\"\"\n element = domish.Element((NS_MUC, 'history'))\n\n for key in self.attributes:\n value = getattr(self, key, None)\n if value is not None:\n if key == 'since':\n stamp = value.astimezone(tzutc())\n element[key] = stamp.strftime('%Y-%m-%dT%H:%M:%SZ')\n else:\n element[key.lower()] = str(value)\n\n return element\n\n\n\nclass BasicPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC client to service.\n\n @type history: L{HistoryOptions}\n \"\"\"\n history = None\n password = None\n\n def toElement(self):\n element = xmppim.AvailabilityPresence.toElement(self)\n\n muc = element.addElement((NS_MUC, 'x'))\n if self.password:\n muc.addElement('password', content=self.password)\n if self.history:\n muc.addChild(self.history.toElement())\n\n return element\n\n\n\nclass UserPresence(xmppim.AvailabilityPresence):\n \"\"\"\n Availability presence sent from MUC service to client.\n\n @ivar affiliation: Affiliation of the entity to the room.\n @type affiliation: C{unicode}\n\n @ivar role: Role of the entity in the room.\n @type role: C{unicode}\n\n @ivar entity: The real JID of the entity this presence is from.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.\n See L{Statuses} for usage notes.\n @type mucStatuses: L{Statuses}\n\n @ivar nick: The nick name of the entity in the room.\n @type nick: C{unicode}\n \"\"\"\n\n affiliation = None\n role = None\n entity = None\n nick = None\n\n mucStatuses = None\n\n childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}\n\n def __init__(self, *args, **kwargs):\n self.mucStatuses = Statuses()\n xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)\n\n\n def _childParser_mucUser(self, element):\n \"\"\"\n Parse the MUC user extension element.\n \"\"\"\n for child in element.elements():\n if child.uri != NS_MUC_USER:\n continue\n\n elif child.name == 'status':\n try:\n value = int(child.getAttribute('code'))\n statusCode = STATUS_CODE.lookupByValue(value)\n except (TypeError, ValueError):\n continue\n\n self.mucStatuses.add(statusCode)\n\n elif child.name == 'item':\n if child.hasAttribute('jid'):\n self.entity = jid.JID(child['jid'])\n\n self.nick = child.getAttribute('nick')\n self.affiliation = child.getAttribute('affiliation')\n self.role = child.getAttribute('role')\n\n for reason in child.elements(NS_MUC_ADMIN, 'reason'):\n self.reason = unicode(reason)\n\n # TODO: destroy\n\n\n\nclass VoiceRequest(xmppim.Message):\n \"\"\"\n Voice request message.\n \"\"\"\n\n def toElement(self):\n element = xmppim.Message.toElement(self)\n\n # build data form\n form = data_form.Form('submit', formNamespace=NS_MUC_REQUEST)\n form.addField(data_form.Field(var='muc#role',\n value='participant',\n label='Requested role'))\n element.addChild(form.toElement())\n\n return element\n\n\n\nclass MUCClientProtocol(xmppim.BasePresenceProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n \"\"\"\n\n timeout = None\n\n presenceTypeParserMap = {\n 'error': generic.ErrorStanza,\n 'available': UserPresence,\n 'unavailable': UserPresence,\n }\n\n def __init__(self, reactor=None):\n XMPPHandler.__init__(self)\n\n if reactor:\n self._reactor = reactor\n else:\n from twisted.internet import reactor\n self._reactor = reactor\n\n\n def connectionInitialized(self):\n \"\"\"\n Called when the XML stream has been initialized.\n\n It initializes several XPath events to handle MUC stanzas that come\n in.\n \"\"\"\n xmppim.BasePresenceProtocol.connectionInitialized(self)\n self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)\n self._roomOccupantMap = {}\n\n\n def _onGroupChat(self, element):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n message = GroupChat.fromElement(element)\n self.groupChatReceived(message)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n Called when a groupchat message was received.\n\n This method is called with a parsed representation of a received\n groupchat message and can be overridden for further processing.\n\n For regular groupchat message, the C{body} attribute contains the\n message body. Conversation history sent by the room upon joining, will\n have the C{delay} attribute set, room subject changes the C{subject}\n attribute. See L{GroupChat} for details.\n\n @param message: Groupchat message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def _sendDeferred(self, stanza):\n \"\"\"\n Send presence stanza, adding a deferred with a timeout.\n\n @param stanza: The presence stanza to send over the wire.\n @type stanza: L{generic.Stanza}\n\n @param timeout: The number of seconds to wait before the deferred is\n timed out.\n @type timeout: C{int}\n\n The deferred object L{defer.Deferred} is returned.\n \"\"\"\n def onResponse(element):\n if element.getAttribute('type') == 'error':\n d.errback(error.exceptionFromStanza(element))\n else:\n d.callback(UserPresence.fromElement(element))\n\n def onTimeout():\n d.errback(xmlstream.TimeoutError(\"Timeout waiting for response.\"))\n\n def cancelTimeout(result):\n if call.active():\n call.cancel()\n\n return result\n\n def recordOccupant(presence):\n occupantJID = presence.sender\n roomJID = occupantJID.userhostJID()\n self._roomOccupantMap[roomJID] = occupantJID\n return presence\n\n call = self._reactor.callLater(DEFER_TIMEOUT, onTimeout)\n\n d = defer.Deferred()\n d.addBoth(cancelTimeout)\n d.addCallback(recordOccupant)\n\n query = \"/presence[@from='%s' or (@from='%s' and @type='error')]\" % (\n stanza.recipient.full(), stanza.recipient.userhost())\n self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)\n self.xmlstream.send(stanza.toElement())\n return d\n\n\n def join(self, roomJID, nick, historyOptions=None, password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires when the entity is in the room or an\n error has occurred.\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n\n presence = BasicPresence(recipient=occupantJID)\n if password:\n presence.password = password\n if historyOptions:\n presence.history = historyOptions\n\n return self._sendDeferred(presence)\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n occupantJID = jid.JID(tuple=(roomJID.user, roomJID.host, nick))\n presence = BasicPresence(recipient=occupantJID)\n return self._sendDeferred(presence)\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = BasicPresence(recipient=occupantJID, show=show,\n status=status)\n return self._sendDeferred(presence)\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n occupantJID = self._roomOccupantMap[roomJID]\n presence = xmppim.AvailabilityPresence(recipient=occupantJID,\n available=False)\n\n return self._sendDeferred(presence)\n\n\n def groupChat(self, roomJID, body):\n \"\"\"\n Send a groupchat message.\n \"\"\"\n message = GroupChat(recipient=roomJID, body=body)\n self.send(message.toElement())\n\n\n def chat(self, occupantJID, body):\n \"\"\"\n Send a private chat message to a user in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#privatemessage\n\n @param occupantJID: The Room JID of the other user.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = PrivateChat(recipient=occupantJID, body=body)\n self.send(message.toElement())\n\n\n def subject(self, roomJID, subject):\n \"\"\"\n Change the subject of a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#subject-mod\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param subject: The subject you want to set.\n @type subject: C{unicode}\n \"\"\"\n message = GroupChat(roomJID.userhostJID(), subject=subject)\n self.send(message.toElement())\n\n\n def invite(self, roomJID, invitee, reason=None):\n \"\"\"\n Invite a xmpp entity to a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#invite\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param invitee: The entity that is being invited.\n @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the invite.\n @type reason: C{unicode}\n \"\"\"\n message = InviteMessage(recipient=roomJID, invitee=invitee,\n reason=reason)\n self.send(message.toElement())\n\n\n def getRegisterForm(self, roomJID):\n \"\"\"\n Grab the registration form for a MUC room.\n\n @param room: The room jabber/xmpp entity id for the requested\n registration form.\n @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_REGISTER)\n return form\n\n request = RegisterRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def register(self, roomJID, options):\n \"\"\"\n Send a request to register for a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = RegisterRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def voice(self, roomJID):\n \"\"\"\n Request voice for a moderated room.\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n message = VoiceRequest(recipient=roomJID)\n self.xmlstream.send(message.toElement())\n\n\n def history(self, roomJID, messages):\n \"\"\"\n Send history to create a MUC based on a one on one chat.\n\n See: http://xmpp.org/extensions/xep-0045.html#continue\n\n @param roomJID: The room jabber/xmpp entity id.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param messages: The history to send to the room as an ordered list of\n message, represented by a dictionary with the keys\n C{'stanza'}, holding the original stanza a\n L{domish.Element}, and C{'timestamp'} with the\n timestamp.\n @type messages: C{list} of L{domish.Element}\n \"\"\"\n\n for message in messages:\n stanza = message['stanza']\n stanza['type'] = 'groupchat'\n\n delay = Delay(stamp=message['timestamp'])\n\n sender = stanza.getAttribute('from')\n if sender is not None:\n delay.sender = jid.JID(sender)\n\n stanza.addChild(delay.toElement())\n\n stanza['to'] = roomJID.userhost()\n if stanza.hasAttribute('from'):\n del stanza['from']\n\n self.xmlstream.send(stanza)\n\n\n def getConfiguration(self, roomJID):\n \"\"\"\n Grab the configuration from the room.\n\n This sends an iq request to the room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @return: A deferred that fires with the room's configuration form as\n a L{data_form.Form} or C{None} if there are no configuration\n options available.\n \"\"\"\n def cb(response):\n form = data_form.findForm(response.query, NS_MUC_CONFIG)\n return form\n\n request = ConfigureRequest(recipient=roomJID, options=None)\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def configure(self, roomJID, options):\n \"\"\"\n Configure a room.\n\n @param roomJID: The room to configure.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param options: A mapping of field names to values, or C{None} to\n cancel.\n @type options: C{dict}\n \"\"\"\n if options is None:\n options = False\n request = ConfigureRequest(recipient=roomJID, options=options)\n return self.request(request)\n\n\n def _getAffiliationList(self, roomJID, affiliation):\n \"\"\"\n Send a request for an affiliation list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(affiliation=affiliation)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def _getRoleList(self, roomJID, role):\n \"\"\"\n Send a request for a role list in a room.\n \"\"\"\n def cb(response):\n stanza = AdminStanza.fromElement(response)\n return stanza.items\n\n request = AdminStanza(recipient=roomJID, stanzaType='get')\n request.items = [AdminItem(role=role)]\n d = self.request(request)\n d.addCallback(cb)\n return d\n\n\n def getMemberList(self, roomJID):\n \"\"\"\n Get the member list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'member')\n\n\n def getAdminList(self, roomJID):\n \"\"\"\n Get the admin list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'admin')\n\n\n def getBanList(self, roomJID):\n \"\"\"\n Get an outcast list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'outcast')\n\n\n def getOwnerList(self, roomJID):\n \"\"\"\n Get an owner list from a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._getAffiliationList(roomJID, 'owner')\n\n\n def getModeratorList(self, roomJID):\n \"\"\"\n Get the moderator list of a room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n d = self._getRoleList(roomJID, 'moderator')\n return d\n\n\n def _setAffiliation(self, roomJID, entity, affiliation,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an entity's affiliation to a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(entity=entity, affiliation=affiliation, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def _setRole(self, roomJID, nick, role,\n reason=None, sender=None):\n \"\"\"\n Send a request to change an occupant's role in a MUC room.\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n item = AdminItem(nick=nick, role=role, reason=reason)\n request.items = [item]\n return self.request(request)\n\n\n def modifyAffiliationList(self, roomJID, entities, affiliation,\n sender=None):\n \"\"\"\n Modify an affiliation list.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entities: The list of entities to change for a room.\n @type entities: C{list} of\n L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param affiliation: The affilation to the entities will acquire.\n @type affiliation: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = AdminStanza(recipient=roomJID, sender=sender,\n stanzaType='set')\n request.items = [AdminItem(entity=entity, affiliation=affiliation)\n for entity in entities]\n\n return self.request(request)\n\n\n def grantVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant voice to an entity.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting voice to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick,\n role='participant',\n reason=reason, sender=sender)\n\n\n def revokeVoice(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Revoke voice from a participant.\n\n This will disallow the entity to send messages to a moderated room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for revoking voice from the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='visitor',\n reason=reason, sender=sender)\n\n\n def grantModerator(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Grant moderator privileges to a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the user in this room.\n @type nick: C{unicode}\n\n @param reason: The reason for granting moderation to the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick=nick, role='moderator',\n reason=reason, sender=sender)\n\n\n def ban(self, roomJID, entity, reason=None, sender=None):\n \"\"\"\n Ban a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param entity: The bare JID of the entity to be banned.\n @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for banning the entity.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setAffiliation(roomJID, entity, 'outcast',\n reason=reason, sender=sender)\n\n\n def kick(self, roomJID, nick, reason=None, sender=None):\n \"\"\"\n Kick a user from a MUC room.\n\n @param roomJID: The bare JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The occupant to be banned.\n @type nick: C{unicode}\n\n @param reason: The reason given for the kick.\n @type reason: C{unicode}\n\n @param sender: The entity sending the request.\n @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._setRole(roomJID, nick, 'none',\n reason=reason, sender=sender)\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n request = DestructionRequest(recipient=roomJID, reason=reason,\n alternate=alternate, password=password)\n\n return self.request(request)\n\n\n\nclass User(object):\n \"\"\"\n A user/entity in a multi-user chat room.\n \"\"\"\n\n def __init__(self, nick, entity=None):\n self.nick = nick\n self.entity = entity\n self.affiliation = 'none'\n self.role = 'none'\n\n self.status = None\n self.show = None\n\n\n\nclass Room(object):\n \"\"\"\n A Multi User Chat Room.\n\n An in memory object representing a MUC room from the perspective of\n a client.\n\n @ivar roomJID: The Room JID of the MUC room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar nick: The nick name for the client in this room.\n @type nick: C{unicode}\n\n @ivar occupantJID: The JID of the occupant in the room. Generated from\n roomJID and nick.\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @ivar locked: Flag signalling a locked room. A locked room first needs\n to be configured before it can be used. See\n L{MUCClientProtocol.getConfiguration} and\n L{MUCClientProtocol.configure}.\n @type locked: C{bool}\n \"\"\"\n\n locked = False\n\n def __init__(self, roomJID, nick):\n \"\"\"\n Initialize the room.\n \"\"\"\n self.roomJID = roomJID\n self.setNick(nick)\n self.roster = {}\n\n\n def setNick(self, nick):\n self.occupantJID = jid.internJID(u\"%s/%s\" % (self.roomJID, nick))\n self.nick = nick\n\n\n def addUser(self, user):\n \"\"\"\n Add a user to the room roster.\n\n @param user: The user object that is being added to the room.\n @type user: L{User}\n \"\"\"\n self.roster[user.nick] = user\n\n\n def inRoster(self, user):\n \"\"\"\n Check if a user is in the MUC room.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n\n return user.nick in self.roster\n\n\n def getUser(self, nick):\n \"\"\"\n Get a user from the room's roster.\n\n @param nick: The nick for the user in the MUC room.\n @type nick: C{unicode}\n \"\"\"\n return self.roster.get(nick)\n\n\n def removeUser(self, user):\n \"\"\"\n Remove a user from the MUC room's roster.\n\n @param user: The user object to check.\n @type user: L{User}\n \"\"\"\n if self.inRoster(user):\n del self.roster[user.nick]\n\n\n\nclass MUCClient(MUCClientProtocol):\n \"\"\"\n Multi-User Chat client protocol.\n\n This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.\n\n @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the\n room. Note that a particular entity can only join a room once\n at a time.\n @type _rooms: C{dict}\n \"\"\"\n\n implements(IMUCClient)\n\n def __init__(self, reactor=None):\n MUCClientProtocol.__init__(self, reactor)\n\n self._rooms = {}\n\n\n def _addRoom(self, room):\n \"\"\"\n Add a room to the room collection.\n\n Rooms are stored by the JID of the room itself. I.e. it uses the Room\n ID and service parts of the Room JID.\n\n @note: An entity can only join a particular room once.\n \"\"\"\n roomJID = room.occupantJID.userhostJID()\n self._rooms[roomJID] = room\n\n\n def _getRoom(self, roomJID):\n \"\"\"\n Grab a room from the room collection.\n\n This uses the Room ID and service parts of the given JID to look up\n the L{Room} instance associated with it.\n\n @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n return self._rooms.get(roomJID)\n\n\n def _removeRoom(self, roomJID):\n \"\"\"\n Delete a room from the room collection.\n \"\"\"\n if roomJID in self._rooms:\n del self._rooms[roomJID]\n\n\n def _getRoomUser(self, stanza):\n \"\"\"\n Lookup the room and user associated with the stanza's sender.\n \"\"\"\n occupantJID = stanza.sender\n\n if not occupantJID:\n return None, None\n\n # when a user leaves a room we need to update it\n room = self._getRoom(occupantJID.userhostJID())\n if room is None:\n # not in the room yet\n return None, None\n\n # Check if user is in roster\n nick = occupantJID.resource\n user = room.getUser(nick)\n\n return room, user\n\n\n def unavailableReceived(self, presence):\n \"\"\"\n Unavailable presence was received.\n\n If this was received from a MUC room occupant JID, that occupant has\n left the room.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None or user is None:\n return\n\n room.removeUser(user)\n self.userLeftRoom(room, user)\n\n\n def availableReceived(self, presence):\n \"\"\"\n Available presence was received.\n \"\"\"\n\n room, user = self._getRoomUser(presence)\n\n if room is None:\n return\n\n if user is None:\n nick = presence.sender.resource\n user = User(nick, presence.entity)\n\n # Update user status\n user.status = presence.status\n user.show = presence.show\n\n if room.inRoster(user):\n self.userUpdatedStatus(room, user, presence.show, presence.status)\n else:\n room.addUser(user)\n self.userJoinedRoom(room, user)\n\n\n def groupChatReceived(self, message):\n \"\"\"\n A group chat message has been received from a MUC room.\n\n There are a few event methods that may get called here.\n L{receivedGroupChat}, L{receivedSubject} or L{receivedHistory}.\n \"\"\"\n room, user = self._getRoomUser(message)\n\n if room is None:\n return\n\n if message.subject:\n self.receivedSubject(room, user, message.subject)\n elif message.delay is None:\n self.receivedGroupChat(room, user, message)\n else:\n self.receivedHistory(room, user, message)\n\n\n def userJoinedRoom(self, room, user):\n \"\"\"\n User has joined a MUC room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that joined the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userLeftRoom(self, room, user):\n \"\"\"\n User has left a room.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n\n @param room: The room the user has joined.\n @type room: L{Room}\n\n @param user: The user that left the MUC room.\n @type user: L{User}\n \"\"\"\n pass\n\n\n def userUpdatedStatus(self, room, user, show, status):\n \"\"\"\n User Presence has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedSubject(self, room, user, subject):\n \"\"\"\n A (new) room subject has been received.\n\n This method will need to be modified inorder for clients to\n do something when this event occurs.\n \"\"\"\n pass\n\n\n def receivedGroupChat(self, room, user, message):\n \"\"\"\n A groupchat message was received.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def receivedHistory(self, room, user, message):\n \"\"\"\n A groupchat message from the room's discussion history was received.\n\n This is identical to L{receivedGroupChat}, with the delayed delivery\n information (timestamp and original sender) in C{message.delay}. For\n anonymous rooms, C{message.delay.sender} is the room's address.\n\n @param room: The room the message was received from.\n @type room: L{Room}\n\n @param user: The user that sent the message, or C{None} if it was a\n message from the room itself.\n @type user: L{User}\n\n @param message: The message.\n @type message: L{GroupChat}\n \"\"\"\n pass\n\n\n def join(self, roomJID, nick, historyOptions=None,\n password=None):\n \"\"\"\n Join a MUC room by sending presence to it.\n\n @param roomJID: The JID of the room the entity is joining.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The nick name for the entitity joining the room.\n @type nick: C{unicode}\n\n @param historyOptions: Options for conversation history sent by the\n room upon joining.\n @type historyOptions: L{HistoryOptions}\n\n @param password: Optional password for the room.\n @type password: C{unicode}\n\n @return: A deferred that fires with the room when the entity is in the\n room, or with a failure if an error has occurred.\n \"\"\"\n def cb(presence):\n \"\"\"\n We have presence that says we joined a room.\n \"\"\"\n if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:\n room.locked = True\n\n return room\n\n def eb(failure):\n self._removeRoom(roomJID)\n return failure\n\n room = Room(roomJID, nick)\n self._addRoom(room)\n\n d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,\n password)\n d.addCallbacks(cb, eb)\n return d\n\n\n def nick(self, roomJID, nick):\n \"\"\"\n Change an entity's nick name in a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#changenick\n\n @param roomJID: The JID of the room, i.e. without a resource.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param nick: The new nick name within the room.\n @type nick: C{unicode}\n \"\"\"\n def cb(presence):\n # Presence confirmation, change the nickname.\n room.setNick(nick)\n return room\n\n room = self._getRoom(roomJID)\n\n d = MUCClientProtocol.nick(self, roomJID, nick)\n d.addCallback(cb)\n return d\n\n\n def leave(self, roomJID):\n \"\"\"\n Leave a MUC room.\n\n See: http://xmpp.org/extensions/xep-0045.html#exit\n\n @param roomJID: The Room JID of the room to leave.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n \"\"\"\n def cb(presence):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.leave(self, roomJID)\n d.addCallback(cb)\n return d\n\n\n def status(self, roomJID, show=None, status=None):\n \"\"\"\n Change user status.\n\n See: http://xmpp.org/extensions/xep-0045.html#changepres\n\n @param roomJID: The Room JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param show: The availability of the entity. Common values are xa,\n available, etc\n @type show: C{unicode}\n\n @param status: The current status of the entity.\n @type status: C{unicode}\n \"\"\"\n room = self._getRoom(roomJID)\n d = MUCClientProtocol.status(self, roomJID, show, status)\n d.addCallback(lambda _: room)\n return d\n\n\n def destroy(self, roomJID, reason=None, alternate=None, password=None):\n \"\"\"\n Destroy a room.\n\n @param roomJID: The JID of the room.\n @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n @param reason: The reason for the destruction of the room.\n @type reason: C{unicode}\n\n @param alternate: The JID of the room suggested as an alternate venue.\n @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}\n\n \"\"\"\n def destroyed(iq):\n self._removeRoom(roomJID)\n\n d = MUCClientProtocol.destroy(self, roomJID, reason, alternate)\n d.addCallback(destroyed)\n return d\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":10,"numItemsPerPage":100,"numTotalItems":2760,"offset":1000,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sInJlcG9JZHMiOlsiNjdkZGIxOGMxZDhlMWE2MzJlMWEwZDRiIl0sImlhdCI6MTc5MTY4OTkyOSwianRpIjoiNTEyMjg2MDctODE3ZC00Yjc3LTgzYjQtZjMwYWYyZWRmMmU2Iiwic3ViIjoiL2RhdGFzZXRzL0FTU0VSVC1LVEgvc3RhY2stc21vbC1kb2NzdHJpbmdzIiwiZXhwIjoxNzkxNjkzNTI5LCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0.2f-wcXMlwVpPZeN5hnmh1RFxJG26-EoQxazSqVs71LNWSfd1dFQRM_6-rejXJQR0kXabgF1w0fviBhd_hhLfAQ","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":2760,"numBytesParquet":64655948}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
function_name stringlengths 1 63 | docstring stringlengths 50 5.89k | masked_code stringlengths 50 882k | implementation stringlengths 169 12.9k | start_line int32 1 14.6k | end_line int32 16 14.6k | file_content stringlengths 274 882k |
|---|---|---|---|---|---|---|
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 884 | 932 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The request ID of the original `PUBLISH` request.
:type request: int
:param publication: The publication ID for the published event.
:type publication: int | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, publication):
"""
:param request: The request ID of the original `PUBLISH` request.
:type request: int
:param publication: The publication ID for the published event.
:type publication: int
"""
assert(type(request) in six.integer_types)
ass... | 1,177 | 1,190 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,193 | 1,215 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of this request.
:type request: int
:param topic: The WAMP or application URI of the PubSub topic to subscribe to.
:type topic: unicode
:param match: The topic matching method to be used for the subscription.
:type match: unicode | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, topic, match = MATCH_EXACT):
"""
:param request: The WAMP request ID of this request.
:type request: int
:param topic: The WAMP or application URI of the PubSub topic to subscribe to.
:type topic: unicode
:param match: The topic matching method to be u... | 1,249 | 1,267 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,270 | 1,306 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The request ID of the original ``SUBSCRIBE`` request.
:type request: int
:param subscription: The subscription ID for the subscribed topic (or topic pattern).
:type subscription: int | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, subscription):
"""
:param request: The request ID of the original ``SUBSCRIBE`` request.
:type request: int
:param subscription: The subscription ID for the subscribed topic (or topic pattern).
:type subscription: int
"""
assert(type(request) in ... | 1,341 | 1,354 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,357 | 1,379 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,426 | 1,448 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,490 | 1,511 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param subscription: The subscription ID this event is dispatched under.
:type subscription: int
:param publication: The publication ID of the dispatched event.
:type publication: int
:param args: Positional values for application-defined exception.
Must be serializable using any serializers in use.
:type args: list... | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, subscription, publication, args = None, kwargs = None, publisher = None):
"""
:param subscription: The subscription ID this event is dispatched under.
:type subscription: int
:param publication: The publication ID of the dispatched event.
:type publication: int
... | 1,546 | 1,573 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,576 | 1,624 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of this request.
:type request: int
:param procedure: The WAMP or application URI of the procedure which should be called.
:type procedure: unicode
:param args: Positional values for application-defined call arguments.
Must be serializable using any serializers in use.
:type args:... | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self,
request,
procedure,
args = None,
kwargs = None,
timeout = None,
receive_progress = None,
discloseMe = None):
"""
:param request: The WAMP request ID of this request.
:... | 1,668 | 1,712 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,715 | 1,786 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of the original `CALL` to cancel.
:type request: int
:param mode: Specifies how to cancel the call (``"skip"``, ``"abort"`` or ``"kill"``).
:type mode: unicode or None | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, mode = None):
"""
:param request: The WAMP request ID of the original `CALL` to cancel.
:type request: int
:param mode: Specifies how to cancel the call (``"skip"``, ``"abort"`` or ``"kill"``).
:type mode: unicode or None
"""
assert(type(request)... | 1,837 | 1,851 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,854 | 1,891 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The request ID of the original `CALL` request.
:type request: int
:param args: Positional values for application-defined event payload.
Must be serializable using any serializers in use.
:type args: list or tuple or None
:param kwargs: Keyword values for application-defined event payload.
Must be ... | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, args = None, kwargs = None, progress = None):
"""
:param request: The request ID of the original `CALL` request.
:type request: int
:param args: Positional values for application-defined event payload.
Must be serializable using any serializers in use.
... | 1,930 | 1,954 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 1,957 | 2,001 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of this request.
:type request: int
:param procedure: The WAMP or application URI of the RPC endpoint provided.
:type procedure: unicode
:param pkeys: The endpoint can work for this list of application partition keys.
:type pkeys: list of int or None
:param discloseCaller: If ``True`... | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, procedure, pkeys = None, discloseCaller = None):
"""
:param request: The WAMP request ID of this request.
:type request: int
:param procedure: The WAMP or application URI of the RPC endpoint provided.
:type procedure: unicode
:param pkeys: The endpoint... | 2,041 | 2,066 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 2,069 | 2,116 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The request ID of the original ``REGISTER`` request.
:type request: int
:param registration: The registration ID for the registered procedure (or procedure pattern).
:type registration: int | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, registration):
"""
:param request: The request ID of the original ``REGISTER`` request.
:type request: int
:param registration: The registration ID for the registered procedure (or procedure pattern).
:type registration: int
"""
assert(type(reque... | 2,154 | 2,167 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 2,170 | 2,192 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of this request.
:type request: int
:param registration: The registration ID for the registration to unregister.
:type registration: int | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, registration):
"""
:param request: The WAMP request ID of this request.
:type request: int
:param registration: The registration ID for the registration to unregister.
:type registration: int
"""
assert(type(request) in six.integer_types)
a... | 2,223 | 2,236 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 2,239 | 2,261 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 2,303 | 2,324 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of this request.
:type request: int
:param registration: The registration ID of the endpoint to be invoked.
:type registration: int
:param args: Positional values for application-defined event payload.
Must be serializable using any serializers in use.
:type args: list or tuple or... | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self,
request,
registration,
args = None,
kwargs = None,
timeout = None,
receive_progress = None,
caller = None,
authid = None,
authrole = None,
... | 2,359 | 2,417 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of the original ``INVOCATION`` to interrupt.
:type request: int
:param mode: Specifies how to interrupt the invocation (``"abort"`` or ``"kill"``).
:type mode: unicode or None | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, mode = None):
"""
:param request: The WAMP request ID of the original ``INVOCATION`` to interrupt.
:type request: int
:param mode: Specifies how to interrupt the invocation (``"abort"`` or ``"kill"``).
:type mode: unicode or None
"""
assert(type(... | 2,580 | 2,594 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 2,597 | 2,634 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
__init__ | :param request: The WAMP request ID of the original call.
:type request: int
:param args: Positional values for application-defined event payload.
Must be serializable using any serializers in use.
:type args: list or tuple or None
:param kwargs: Keyword values for application-defined event payload.
Must be seria... | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | def __init__(self, request, args = None, kwargs = None, progress = None):
"""
:param request: The WAMP request ID of the original call.
:type request: int
:param args: Positional values for application-defined event payload.
Must be serializable using any serializers in use.
:... | 2,674 | 2,698 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
parse | Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class. | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... | @staticmethod
def parse(wmsg):
"""
Verifies and parses an unserialized raw message into an actual WAMP message instance.
:param wmsg: The unserialized raw message.
:type wmsg: list
:returns: An instance of this class.
"""
## this should already be verified by WampSerial... | 2,701 | 2,745 | ###############################################################################
##
## Copyright (C) 2013-2014 Tavendo GmbH
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## h... |
_snn_imp | Internal function for fast snn calculation
Parameters
----------
ind : int
Indices return by kNN.
ref_set_ : int, optional (default=10)
specifies the number of shared nearest neighbors to create the
reference set. Note that ref_set must be smaller than n_neighbors. | # -*- coding: utf-8 -*-
"""Subspace Outlier Detection (SOD)
"""
# Author: Yahya Almardeny <almardeny@gmail.com>
# License: BSD 2 clause
import numpy as np
import numba as nb
from sklearn.neighbors import NearestNeighbors
from sklearn.utils import check_array
from ..utils.utility import check_parameter
from .base impo... | @nb.njit(parallel=True)
def _snn_imp(ind, ref_set_):
"""Internal function for fast snn calculation
Parameters
----------
ind : int
Indices return by kNN.
ref_set_ : int, optional (default=10)
specifies the number of shared nearest neighbors to create the
reference set. Note... | 16 | 40 | # -*- coding: utf-8 -*-
"""Subspace Outlier Detection (SOD)
"""
# Author: Yahya Almardeny <almardeny@gmail.com>
# License: BSD 2 clause
import numpy as np
import numba as nb
from sklearn.neighbors import NearestNeighbors
from sklearn.utils import check_array
from ..utils.utility import check_parameter
from .base impo... |
fit | Fit detector. y is ignored in unsupervised methods.
Parameters
----------
X : numpy array of shape (n_samples, n_features)
The input samples.
y : Ignored
Not used, present for API consistency by convention.
Returns
-------
self : object
Fitted estimator. | # -*- coding: utf-8 -*-
"""Subspace Outlier Detection (SOD)
"""
# Author: Yahya Almardeny <almardeny@gmail.com>
# License: BSD 2 clause
import numpy as np
import numba as nb
from sklearn.neighbors import NearestNeighbors
from sklearn.utils import check_array
from ..utils.utility import check_parameter
from .base impo... | def fit(self, X, y=None):
"""Fit detector. y is ignored in unsupervised methods.
Parameters
----------
X : numpy array of shape (n_samples, n_features)
The input samples.
y : Ignored
Not used, present for API consistency by convention.
Retur... | 115 | 138 | # -*- coding: utf-8 -*-
"""Subspace Outlier Detection (SOD)
"""
# Author: Yahya Almardeny <almardeny@gmail.com>
# License: BSD 2 clause
import numpy as np
import numba as nb
from sklearn.neighbors import NearestNeighbors
from sklearn.utils import check_array
from ..utils.utility import check_parameter
from .base impo... |
_snn | This function is called internally to calculate the shared nearest
neighbors (SNN). SNN is reported to be more robust than k nearest
neighbors.
Returns
-------
snn_indices : numpy array of shape (n_shared_nearest_neighbors,)
The indices of top k shared nearest neighbors for each observation. | # -*- coding: utf-8 -*-
"""Subspace Outlier Detection (SOD)
"""
# Author: Yahya Almardeny <almardeny@gmail.com>
# License: BSD 2 clause
import numpy as np
import numba as nb
from sklearn.neighbors import NearestNeighbors
from sklearn.utils import check_array
from ..utils.utility import check_parameter
from .base impo... | def _snn(self, X):
"""This function is called internally to calculate the shared nearest
neighbors (SNN). SNN is reported to be more robust than k nearest
neighbors.
Returns
-------
snn_indices : numpy array of shape (n_shared_nearest_neighbors,)
The indi... | 159 | 173 | # -*- coding: utf-8 -*-
"""Subspace Outlier Detection (SOD)
"""
# Author: Yahya Almardeny <almardeny@gmail.com>
# License: BSD 2 clause
import numpy as np
import numba as nb
from sklearn.neighbors import NearestNeighbors
from sklearn.utils import check_array
from ..utils.utility import check_parameter
from .base impo... |
test_feedback_can_be_filtered_by_all_products_and_versions | Tests product filtering in dashboard
1. Verify that at least one product exists
2. Verify that filtering by product returns results
3. Verify that versions show up when you choose a product
4. Verify that the state of the filters are correct after being applied
5. Verify product and version values in the URL
NB: We d... | # This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import pytest
from unittestzero import Assert
from pages.dashboard import DashboardPage
class TestProductFilter(objec... | @pytest.mark.nondestructive
def test_feedback_can_be_filtered_by_all_products_and_versions(self, mozwebqa):
"""Tests product filtering in dashboard
1. Verify that at least one product exists
2. Verify that filtering by product returns results
3. Verify that versions show up when... | 12 | 60 | # This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import pytest
from unittestzero import Assert
from pages.dashboard import DashboardPage
class TestProductFilter(objec... |
test_get_significant_states_include_entity | Test if significant states are returned when including entities.
We should only get back changes of the media_player.test entity. | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... | def test_get_significant_states_include_entity(hass_history):
"""Test if significant states are returned when including entities.
We should only get back changes of the media_player.test entity.
"""
hass = hass_history
zero, four, states = record_states(hass)
del states["media_player.test2"]
... | 287 | 308 | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... |
test_get_significant_states_include | Test significant states when including domains and entities.
We should only get back changes of the media_player.test entity and the
thermostat domain. | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... | def test_get_significant_states_include(hass_history):
"""Test significant states when including domains and entities.
We should only get back changes of the media_player.test entity and the
thermostat domain.
"""
hass = hass_history
zero, four, states = record_states(hass)
del states["medi... | 311 | 334 | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... |
test_get_significant_states_include_exclude_entity | Test if significant states when excluding and including domains.
We should not get back any changes since we include only
media_player.test but also exclude it. | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... | def test_get_significant_states_include_exclude_entity(hass_history):
"""Test if significant states when excluding and including domains.
We should not get back any changes since we include only
media_player.test but also exclude it.
"""
hass = hass_history
zero, four, states = record_states(ha... | 364 | 388 | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... |
test_get_significant_states_include_exclude | Test if significant states when in/excluding domains and entities.
We should only get back changes of the media_player.test2 entity. | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... | def test_get_significant_states_include_exclude(hass_history):
"""Test if significant states when in/excluding domains and entities.
We should only get back changes of the media_player.test2 entity.
"""
hass = hass_history
zero, four, states = record_states(hass)
del states["media_player.test"]... | 391 | 418 | """The tests the History component."""
# pylint: disable=protected-access,invalid-name
from datetime import timedelta
import json
from unittest.mock import patch, sentinel
import pytest
from pytest import approx
from homeassistant.components import history, recorder
from homeassistant.components.recorder.history impo... |
_describe_entity | Describes the given traffic entity as an HTML list.
:param entity: An object of an owlready2 class.
:return: The HTML-representation of entity. | # Visualizer is for debugging purposes only
import logging
import math
import random
import threading
import http.server
import socketserver
import os
import re
from shapely import wkt
import matplotlib.pyplot as plt
import mpld3
import screeninfo
import tempfile
import webbrowser
import owlready2
from shapely import ... | def _describe_entity(entity):
"""
Describes the given traffic entity as an HTML list.
:param entity: An object of an owlready2 class.
:return: The HTML-representation of entity.
"""
cls = phenomena_extraction.get_most_specific_classes([entity])
label = "<table class=\"m-2\"><thead><tr><th>In... | 579 | 605 | # Visualizer is for debugging purposes only
import logging
import math
import random
import threading
import http.server
import socketserver
import os
import re
from shapely import wkt
import matplotlib.pyplot as plt
import mpld3
import screeninfo
import tempfile
import webbrowser
import owlready2
from shapely import ... |
notas | Função para analisar notas e situação de varios alunos.
:param n: Uma ou mais notas dos alunos (aceita varias)
:param sit: Valor opcional, indicando se deve ou não adicionar a situação.
:return: Dicionario com varias informações sobre a situação da turma. | # MASKED: notas function (lines 1-22)
resp = notas(5, 4, 3, sit=True)
print(resp) | def notas(*n, sit=False):
"""
Função para analisar notas e situação de varios alunos.
:param n: Uma ou mais notas dos alunos (aceita varias)
:param sit: Valor opcional, indicando se deve ou não adicionar a situação.
:return: Dicionario com varias informações sobre a situação da turma.
"""
di... | 1 | 22 | def notas(*n, sit=False):
"""
Função para analisar notas e situação de varios alunos.
:param n: Uma ou mais notas dos alunos (aceita varias)
:param sit: Valor opcional, indicando se deve ou não adicionar a situação.
:return: Dicionario com varias informações sobre a situação da turma.
"""
di... |
getProperty | str getProperty(str, str)
This function searches a configFile for a specific property and returns its value
Args:
configFile: The configuration file to open
prop: The property to search for
Returns:
string: The property value if found or None for no value found | """
This module provides an interface for reading and writing to a HackPSU RaspberryPi Scanner config file
Methods:
getProperty(configFile, prop)
Get a property from a config file by reading the config file until the desired property is found
setProperty(configFile, prop, value)
Set a property by updating the co... | def getProperty(configFile, prop):
"""
str getProperty(str, str)
This function searches a configFile for a specific property and returns its value
Args:
configFile: The configuration file to open
prop: The property to search for
Returns:
string: The property value if found or None for no value found
... | 65 | 95 | """
This module provides an interface for reading and writing to a HackPSU RaspberryPi Scanner config file
Methods:
getProperty(configFile, prop)
Get a property from a config file by reading the config file until the desired property is found
setProperty(configFile, prop, value)
Set a property by updating the co... |
_get_urls_for_cik | Get all urls for specific company according to CIK.
Must match start date, end date, filing_type, and count parameters.
Args:
cik (str): CIK for company.
**kwargs: Anything to be passed to requests when making get request.
See keyword arguments accepted for
``secedgar.client._base.AbstractClie... | import asyncio
import os
import warnings
from datetime import date
from secedgar.cik_lookup import CIKLookup
from secedgar.client import NetworkClient
from secedgar.core._base import AbstractFiling
from secedgar.core.filing_types import FilingType
from secedgar.exceptions import FilingTypeError
from secedgar.utils imp... | def _get_urls_for_cik(self, cik, **kwargs):
"""Get all urls for specific company according to CIK.
Must match start date, end date, filing_type, and count parameters.
Args:
cik (str): CIK for company.
**kwargs: Anything to be passed to requests when making get reque... | 172 | 205 | import asyncio
import os
import warnings
from datetime import date
from secedgar.cik_lookup import CIKLookup
from secedgar.client import NetworkClient
from secedgar.core._base import AbstractFiling
from secedgar.core.filing_types import FilingType
from secedgar.exceptions import FilingTypeError
from secedgar.utils imp... |
get_default_monitors | Returns a default set of typically-used monitors.
Args:
loss_op: `Tensor`, the loss tensor. This will be printed using `PrintTensor`
at the default interval.
summary_op: See `SummarySaver`.
save_summary_steps: See `SummarySaver`.
output_dir: See `SummarySaver`.
summary_writer: See `SummarySaver`.
Ret... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def get_default_monitors(loss_op=None, summary_op=None, save_summary_steps=100,
output_dir=None, summary_writer=None):
"""Returns a default set of typically-used monitors.
Args:
loss_op: `Tensor`, the loss tensor. This will be printed using `PrintTensor`
at the default interval... | 783 | 805 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
set_estimator | A setter called automatically by the target estimator.
If the estimator is locked, this method does nothing.
Args:
estimator: the estimator that this monitor monitors.
Raises:
ValueError: if the estimator is None. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def set_estimator(self, estimator):
"""A setter called automatically by the target estimator.
If the estimator is locked, this method does nothing.
Args:
estimator: the estimator that this monitor monitors.
Raises:
ValueError: if the estimator is None.
"""
if self._estimator_loc... | 127 | 143 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
begin | Called at the beginning of training.
When called, the default graph is the one we are executing.
Args:
max_steps: `int`, the maximum global step this training will run until.
Raises:
ValueError: if we've already begun a run. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def begin(self, max_steps=None):
"""Called at the beginning of training.
When called, the default graph is the one we are executing.
Args:
max_steps: `int`, the maximum global step this training will run until.
Raises:
ValueError: if we've already begun a run.
"""
if self._begun... | 153 | 167 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
end | Callback at the end of training/evaluation.
Args:
session: A `tf.Session` object that can be used to run ops.
Raises:
ValueError: if we've not begun a run. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def end(self, session=None):
"""Callback at the end of training/evaluation.
Args:
session: A `tf.Session` object that can be used to run ops.
Raises:
ValueError: if we've not begun a run.
"""
_ = session
if not self._begun:
raise ValueError("end called without begin.")
... | 169 | 182 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
epoch_begin | Begin epoch.
Args:
epoch: `int`, the epoch number.
Raises:
ValueError: if we've already begun an epoch, or `epoch` < 0. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def epoch_begin(self, epoch):
"""Begin epoch.
Args:
epoch: `int`, the epoch number.
Raises:
ValueError: if we've already begun an epoch, or `epoch` < 0.
"""
if self._current_epoch is not None:
raise ValueError("epoch_begin called twice without epoch_end.")
if epoch < 0:
... | 184 | 197 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
epoch_end | End epoch.
Args:
epoch: `int`, the epoch number.
Raises:
ValueError: if we've not begun an epoch, or `epoch` number does not match. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def epoch_end(self, epoch):
"""End epoch.
Args:
epoch: `int`, the epoch number.
Raises:
ValueError: if we've not begun an epoch, or `epoch` number does not match.
"""
if self._current_epoch != epoch:
raise ValueError(
"epoch_end expected %s but got %s.", self._current... | 199 | 211 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
step_begin | Callback before training step begins.
You may use this callback to request evaluation of additional tensors
in the graph.
Args:
step: `int`, the current value of the global step.
Returns:
List of `Tensor` objects or string tensor names to be run.
Raises:
ValueError: if we've already begun a step, or `step` < ... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def step_begin(self, step):
"""Callback before training step begins.
You may use this callback to request evaluation of additional tensors
in the graph.
Args:
step: `int`, the current value of the global step.
Returns:
List of `Tensor` objects or string tensor names to be run.
... | 213 | 233 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes an `EveryN` monitor.
Args:
every_n_steps: `int`, the number of steps to allow between callbacks.
first_n_steps: `int`, specifying the number of initial steps during
which the callbacks will always be executed, regardless of the value
of `every_n_steps`. Note that this value is relative to the g... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, every_n_steps=100, first_n_steps=1):
"""Initializes an `EveryN` monitor.
Args:
every_n_steps: `int`, the number of steps to allow between callbacks.
first_n_steps: `int`, specifying the number of initial steps during
which the callbacks will always be executed, regardle... | 313 | 329 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
step_begin | Overrides `BaseMonitor.step_begin`.
When overriding this method, you must call the super implementation.
Args:
step: `int`, the current value of the global step.
Returns:
A `list`, the result of every_n_step_begin, if that was called this step,
or an empty list otherwise.
Raises:
ValueError: if called more t... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def step_begin(self, step):
"""Overrides `BaseMonitor.step_begin`.
When overriding this method, you must call the super implementation.
Args:
step: `int`, the current value of the global step.
Returns:
A `list`, the result of every_n_step_begin, if that was called this step,
or an ... | 372 | 393 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Create a StopAtStep monitor.
This monitor requests stop after either a number of steps have been
executed or a last step has been reached. Only of the two options can be
specified.
if `num_steps` is specified, it indicates the number of steps to execute
after `begin()` is called. If instead `last_step` is specified... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, num_steps=None, last_step=None):
"""Create a StopAtStep monitor.
This monitor requests stop after either a number of steps have been
executed or a last step has been reached. Only of the two options can be
specified.
if `num_steps` is specified, it indicates the number of ste... | 430 | 455 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes a PrintTensor monitor.
Args:
tensor_names: `dict` of tag to tensor names or
`iterable` of tensor names (strings).
every_n: `int`, print every N steps. See `PrintN.`
first_n: `int`, also print the first N steps. See `PrintN.` | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, tensor_names, every_n=100, first_n=1):
"""Initializes a PrintTensor monitor.
Args:
tensor_names: `dict` of tag to tensor names or
`iterable` of tensor names (strings).
every_n: `int`, print every N steps. See `PrintN.`
first_n: `int`, also print the first N step... | 482 | 494 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes a `SummarySaver` monitor.
Args:
summary_op: `Tensor` of type `string`. A serialized `Summary` protocol
buffer, as output by TF summary methods like `scalar_summary` or
`merge_all_summaries`.
save_steps: `int`, save summaries every N steps. See `EveryN`.
output_dir: `string`, the directory... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self,
summary_op,
save_steps=100,
output_dir=None,
summary_writer=None,
scaffold=None):
"""Initializes a `SummarySaver` monitor.
Args:
summary_op: `Tensor` of type `string`. A serialized `Summary` protocol
... | 553 | 578 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes a ValidationMonitor.
Args:
x: See `BaseEstimator.evaluate`.
y: See `BaseEstimator.evaluate`.
input_fn: See `BaseEstimator.evaluate`.
batch_size: See `BaseEstimator.evaluate`.
eval_steps: See `BaseEstimator.evaluate`.
every_n_steps: Check for new checkpoints to evaluate every N steps. If a
... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, x=None, y=None, input_fn=None, batch_size=None,
eval_steps=None,
every_n_steps=100, metrics=None, early_stopping_rounds=None,
early_stopping_metric="loss",
early_stopping_metric_minimize=True, name=None):
"""Initializes a ValidationMon... | 619 | 671 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes a CaptureVariable monitor.
Args:
var_name: `string`. The variable name, including suffix (typically ":0").
every_n: `int`, print every N steps. See `PrintN.`
first_n: `int`, also print the first N steps. See `PrintN.` | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, var_name, every_n=100, first_n=1):
"""Initializes a CaptureVariable monitor.
Args:
var_name: `string`. The variable name, including suffix (typically ":0").
every_n: `int`, print every N steps. See `PrintN.`
first_n: `int`, also print the first N steps. See `PrintN.`
... | 752 | 762 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes GraphDump monitor.
Args:
ignore_ops: `list` of `string`. Names of ops to ignore.
If None, `GraphDump.IGNORE_OPS` is used. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, ignore_ops=None):
"""Initializes GraphDump monitor.
Args:
ignore_ops: `list` of `string`. Names of ops to ignore.
If None, `GraphDump.IGNORE_OPS` is used.
"""
super(GraphDump, self).__init__()
self._ignore_ops = ignore_ops or GraphDump.IGNORE_OPS
self._data ... | 817 | 826 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initialize CheckpointSaver monitor.
Args:
checkpoint_dir: `str`, base directory for the checkpoint files.
save_secs: `int`, save every N secs.
save_steps: `int`, save every N steps.
saver: `Saver` object, used for saving.
checkpoint_basename: `str`, base name for the checkpoint files.
scaffold: `Scaffold`,... | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self,
checkpoint_dir,
save_secs=None,
save_steps=None,
saver=None,
checkpoint_basename="model.ckpt",
scaffold=None):
"""Initialize CheckpointSaver monitor.
Args:
checkpoint_dir: `str`, base directory ... | 1,022 | 1,058 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
__init__ | Initializes NanLoss monitor.
Args:
loss_tensor: `Tensor`, the loss tensor.
every_n_steps: `int`, run check every this many steps.
fail_on_nan_loss: `bool`, whether to raise exception when loss is NaN. | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | def __init__(self, loss_tensor, every_n_steps=100, fail_on_nan_loss=True):
"""Initializes NanLoss monitor.
Args:
loss_tensor: `Tensor`, the loss tensor.
every_n_steps: `int`, run check every this many steps.
fail_on_nan_loss: `bool`, whether to raise exception when loss is NaN.
"""
... | 1,148 | 1,158 | # Copyright 2016 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... |
load_collada | Load a COLLADA (.dae) file into a list of trimesh kwargs.
Parameters
----------
file_obj : file object
Containing a COLLADA file
resolver : trimesh.visual.Resolver or None
For loading referenced files, like texture images
kwargs : **
Passed to trimesh.Trimesh.__init__
Returns
-------
loaded : list of dict
kwa... | import io
import copy
import uuid
import numpy as np
try:
# pip install pycollada
import collada
except BaseException:
collada = None
try:
import PIL.Image
except ImportError:
pass
from .. import util
from .. import visual
from ..constants import log
# MASKED: load_collada function (lines 24-... | def load_collada(file_obj, resolver=None, **kwargs):
"""
Load a COLLADA (.dae) file into a list of trimesh kwargs.
Parameters
----------
file_obj : file object
Containing a COLLADA file
resolver : trimesh.visual.Resolver or None
For loading referenced files, like texture images
... | 24 | 68 | import io
import copy
import uuid
import numpy as np
try:
# pip install pycollada
import collada
except BaseException:
collada = None
try:
import PIL.Image
except ImportError:
pass
from .. import util
from .. import visual
from ..constants import log
def load_collada(file_obj, resolver=None, ... |
load_zae | Load a ZAE file, which is just a zipped DAE file.
Parameters
-------------
file_obj : file object
Contains ZAE data
resolver : trimesh.visual.Resolver
Resolver to load additional assets
kwargs : dict
Passed to load_collada
Returns
------------
loaded : dict
Results of loading | import io
import copy
import uuid
import numpy as np
try:
# pip install pycollada
import collada
except BaseException:
collada = None
try:
import PIL.Image
except ImportError:
pass
from .. import util
from .. import visual
from ..constants import log
def load_collada(file_obj, resolver=None, ... | def load_zae(file_obj, resolver=None, **kwargs):
"""
Load a ZAE file, which is just a zipped DAE file.
Parameters
-------------
file_obj : file object
Contains ZAE data
resolver : trimesh.visual.Resolver
Resolver to load additional assets
kwargs : dict
Passed to load_colla... | 367 | 401 | import io
import copy
import uuid
import numpy as np
try:
# pip install pycollada
import collada
except BaseException:
collada = None
try:
import PIL.Image
except ImportError:
pass
from .. import util
from .. import visual
from ..constants import log
def load_collada(file_obj, resolver=None, ... |
fpredict | ---------------------------------------------------------------------------
Computes the prediction.
Parameters
----------
L: list
List containing the data. It must be a two-dimensional list containing
multiple rows. Each row must include as first element the ordered predictor
and as nth elements the nth ... | # (c) Copyright [2018-2021] Micro Focus or one of its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicabl... | def fpredict(self, L: list):
"""
---------------------------------------------------------------------------
Computes the prediction.
Parameters
----------
L: list
List containing the data. It must be a two-dimensional list containing
multiple rows. Each row must includ... | 201 | 312 | # (c) Copyright [2018-2021] Micro Focus or one of its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicabl... |
test_arraystringreader | here is my test code
https://docs.pytest.org/en/stable/getting-started.html#create-your-first-test | import numpy as np
from .. import ArrayStringReader
# MASKED: test_arraystringreader function (lines 6-19) | def test_arraystringreader():
"""here is my test code
https://docs.pytest.org/en/stable/getting-started.html#create-your-first-test
"""
size = 8
sample_array = np.random.rand(size).astype('float32')
text = ','.join([str(x) for x in sample_array])
reader = ArrayStringReader()
crafted_do... | 6 | 19 | import numpy as np
from .. import ArrayStringReader
def test_arraystringreader():
"""here is my test code
https://docs.pytest.org/en/stable/getting-started.html#create-your-first-test
"""
size = 8
sample_array = np.random.rand(size).astype('float32')
text = ','.join([str(x) for x in sample_a... |
decode_hypothesis | Decode a list of hypotheses into a list of strings.
Args:
hypotheses_list: List of Hypothesis.
Returns:
A list of strings. | # Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by appli... | def decode_hypothesis(self, hypotheses_list: List[Hypothesis]) -> List[Union[Hypothesis, NBestHypotheses]]:
"""
Decode a list of hypotheses into a list of strings.
Args:
hypotheses_list: List of Hypothesis.
Returns:
A list of strings.
"""
for... | 198 | 225 | # Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by appli... |
__init__ | construct me with the given msg and profile active flag
Args:
msg(str): the message to show if profiling is active
profile(bool): True if messages should be shown | '''
Created on 2021-08-19
@author: wf
'''
from unittest import TestCase
import time
import getpass
import os
class BaseTest(TestCase):
'''
base test case
'''
def setUp(self,debug=False,profile=True):
'''
setUp test environment
'''
TestCase.setUp(self)
self.... | def __init__(self,msg,profile=True):
'''
construct me with the given msg and profile active flag
Args:
msg(str): the message to show if profiling is active
profile(bool): True if messages should be shown
'''
self.msg=msg
self.profile=p... | 43 | 55 | '''
Created on 2021-08-19
@author: wf
'''
from unittest import TestCase
import time
import getpass
import os
class BaseTest(TestCase):
'''
base test case
'''
def setUp(self,debug=False,profile=True):
'''
setUp test environment
'''
TestCase.setUp(self)
self.... |
testFileProxy | [summary]
Args:
filename ([type]): [description]
fs_out (int, optional): [description]. Defaults to 999. | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def testFileProxy(filename,fs_out=999):
"""[summary]
Args:
filename ([type]): [description]
fs_out (int, optional): [description]. Defaults to 999.
"""
from mindaffectBCI.decoder.FileProxyHub import FileProxyHub
U = FileProxyHub(filename)
from sigViewer import sigViewer
... | 1,285 | 1,301 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
testFileProxy2 | [summary]
Args:
filename ([type]): [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def testFileProxy2(filename):
"""[summary]
Args:
filename ([type]): [description]
"""
from mindaffectBCI.decoder.FileProxyHub import FileProxyHub
U = FileProxyHub(filename)
fs = 200
fs_out = 200
# test with a filter + downsampler
ppfn= butterfilt_and_downsample(order=4, ... | 1,303 | 1,341 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
testElectrodeQualities | [summary]
Args:
X ([type]): [description]
fs (int, optional): [description]. Defaults to 200.
pktsize (int, optional): [description]. Defaults to 20.
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def testElectrodeQualities(X,fs=200,pktsize=20):
"""[summary]
Args:
X ([type]): [description]
fs (int, optional): [description]. Defaults to 200.
pktsize (int, optional): [description]. Defaults to 20.
Returns:
[type]: [description]
"""
# recurse if more dims th... | 1,350 | 1,379 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
connect | [make a connection to the utopia host]
Args:
host ([type], optional): [description]. Defaults to None.
port (int, optional): [description]. Defaults to -1.
queryifhostnotfound (bool, optional): [description]. Defaults to True.
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def connect(self, host=None, port=-1, queryifhostnotfound=True):
"""[make a connection to the utopia host]
Args:
host ([type], optional): [description]. Defaults to None.
port (int, optional): [description]. Defaults to -1.
queryifhostnotfound (bool, optional): [... | 92 | 112 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
initDataRingBuffer | [initialize the data ring buffer, by getting some seed messages and datapackets to get the data sizes etc.]
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def initDataRingBuffer(self):
"""[initialize the data ring buffer, by getting some seed messages and datapackets to get the data sizes etc.]
Returns:
[type]: [description]
"""
print("geting some initial data to setup the ring buffer")
# get some ... | 153 | 227 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
add_sample_timestamps | add per-sample timestamp information to the data matrix
Args:
d (np.ndarray): (t,d) the data matrix to attach time stamps to
timestamp (float): the timestamp of the last sample of d
fs (float): the nomional sample rate of d
Returns:
np.ndarray: (t,d+1) data matrix with attached time-stamp channel | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def add_sample_timestamps(self,d:np.ndarray,timestamp:float,fs:float):
"""add per-sample timestamp information to the data matrix
Args:
d (np.ndarray): (t,d) the data matrix to attach time stamps to
timestamp (float): the timestamp of the last sample of d
fs (flo... | 290 | 307 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
plot_raw_preproc_data | [debugging function to check the diff between the raw and pre-processed data]
Args:
d_raw ([type]): [description]
d_preproc ([type]): [description]
ts ([type]): [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def plot_raw_preproc_data(self, d_raw, d_preproc, ts):
"""[debugging function to check the diff between the raw and pre-processed data]
Args:
d_raw ([type]): [description]
d_preproc ([type]): [description]
ts ([type]): [description]
"""
... | 309 | 332 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
update_and_send_ElectrodeQualities | [compute running estimate of electrode qality and stream it]
Args:
d_raw (np.ndarray): [description]
d_preproc (np.ndarray): [description]
ts (int): [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def update_and_send_ElectrodeQualities(self, d_raw: np.ndarray, d_preproc: np.ndarray, ts: int):
"""[compute running estimate of electrode qality and stream it]
Args:
d_raw (np.ndarray): [description]
d_preproc (np.ndarray): [description]
ts (int): [description]
... | 363 | 411 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
update_electrode_powers | [track exp-weighted-moving average centered power for 2 input streams]
Args:
d_raw (np.ndarray): [description]
d_preproc (np.ndarray): [description]
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def update_electrode_powers(self, d_raw: np.ndarray, d_preproc:np.ndarray):
"""[track exp-weighted-moving average centered power for 2 input streams]
Args:
d_raw (np.ndarray): [description]
d_preproc (np.ndarray): [description]
Returns:
[type]: [descript... | 413 | 430 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
extract_msgs_segment | [extract the messages between start/end time stamps]
Args:
bgn_ts ([type]): [description]
end_ts ([type], optional): [description]. Defaults to None.
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def extract_msgs_segment(self, bgn_ts, end_ts=None):
"""[extract the messages between start/end time stamps]
Args:
bgn_ts ([type]): [description]
end_ts ([type], optional): [description]. Defaults to None.
Returns:
[type]: [description]
""" ... | 577 | 597 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
run | [test run the interface forever, just getting and storing data]
Args:
timeout_ms (int, optional): [description]. Defaults to 30000. | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def run(self, timeout_ms=30000):
"""[test run the interface forever, just getting and storing data]
Args:
timeout_ms (int, optional): [description]. Defaults to 30000.
"""
t0 = self.getTimeStamp()
# test getting 5s data
tstart = self.data... | 599 | 621 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
fit | [summary]
Args:
X ([type]): [description]
fs (float, optional): [description]. Defaults to None.
zi ([type], optional): [description]. Defaults to None.
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def fit(self, X, fs:float =None, zi=None):
"""[summary]
Args:
X ([type]): [description]
fs (float, optional): [description]. Defaults to None.
zi ([type], optional): [description]. Defaults to None.
Returns:
[type]: [description]
""" ... | 663 | 704 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
transform | [summary]
Args:
X ([type]): [description]
Y ([type], optional): [description]. Defaults to None.
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def transform(self, X, Y=None):
"""[summary]
Args:
X ([type]): [description]
Y ([type], optional): [description]. Defaults to None.
Returns:
[type]: [description]
"""
# propogate the filter coefficients between calls
if no... | 706 | 754 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
transform | [transform Stimulus-encoded to brain-encoded]
Args:
X ([type]): [description]
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def transform(self, X):
"""[transform Stimulus-encoded to brain-encoded]
Args:
X ([type]): [description]
Returns:
[type]: [description]
"""
if X is None:
return None
# keep old fitler state for the later ... | 826 | 856 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
fit | [summary]
Args:
X ([type]): [description]
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def fit(self,X):
"""[summary]
Args:
X ([type]): [description]
Returns:
[type]: [description]
"""
self.sX_N = X.shape[0]
if self.car and X.shape[-1]>4:
X = X.copy() - np.mean(X,-1,keepdims=True)
self.sX = np.sum(X,a... | 921 | 936 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
transform | [compute the exponientially weighted centered power of X]
Args:
X (np.ndarray): [description]
Returns:
[type]: [description] | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def transform(self, X: np.ndarray):
"""[compute the exponientially weighted centered power of X]
Args:
X (np.ndarray): [description]
Returns:
[type]: [description]
"""
if self.sX is None: # not fitted yet!
return self.fit... | 938 | 963 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
transform | add per-sample timestamp information to the data matrix
Args:
timestamp (float): the timestamp of the last sample of d
nsamp(int): number of samples to interpolate
Returns:
np.ndarray: (nsamp) the interpolated time-stamps | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def transform(self,timestamp:float,nsamp:int=1):
"""add per-sample timestamp information to the data matrix
Args:
timestamp (float): the timestamp of the last sample of d
nsamp(int): number of samples to interpolate
Returns:
np.ndarray: (nsamp) the inter... | 1,043 | 1,083 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
testcase | [summary]
Args:
npkt (int, optional): [description]. Defaults to 1000.
fs (int, optional): [description]. Defaults to 100. | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def testcase(self, npkt=1000, fs=100):
"""[summary]
Args:
npkt (int, optional): [description]. Defaults to 1000.
fs (int, optional): [description]. Defaults to 100.
"""
# generate random packet sizes
nsamp = np.random.random_integers(0,10,size... | 1,085 | 1,111 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
transform | add per-sample timestamp information to the data matrix
Args:
X (float): the data to decorrelate
nsamp(int): number of samples to interpolate
Returns:
np.ndarray: the decorrelated data | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def transform(self,X):
"""add per-sample timestamp information to the data matrix
Args:
X (float): the data to decorrelate
nsamp(int): number of samples to interpolate
Returns:
np.ndarray: the decorrelated data
"""
if not hasattr(self,'W_... | 1,138 | 1,153 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
testcase | [summary]
Args:
dur (int, optional): [description]. Defaults to 3.
fs (int, optional): [description]. Defaults to 100.
blksize (int, optional): [description]. Defaults to 10. | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def testcase(self, dur=3, fs=100, blksize=10):
"""[summary]
Args:
dur (int, optional): [description]. Defaults to 3.
fs (int, optional): [description]. Defaults to 100.
blksize (int, optional): [description]. Defaults to 10.
"""
import num... | 1,155 | 1,188 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
transform | add per-sample timestamp information to the data matrix
Args:
X (float): the data to decorrelate
Returns:
np.ndarray: the decorrelated data | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def transform(self,X):
"""add per-sample timestamp information to the data matrix
Args:
X (float): the data to decorrelate
Returns:
np.ndarray: the decorrelated data
"""
if not hasattr(self,'sigma2_'):
self.fit(X)
X, self.W_ = st... | 1,214 | 1,228 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
testcase | [summary]
Args:
dur (int, optional): [description]. Defaults to 3.
fs (int, optional): [description]. Defaults to 100.
blksize (int, optional): [description]. Defaults to 10. | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... | def testcase(self, dur=3, fs=100, blksize=10):
"""[summary]
Args:
dur (int, optional): [description]. Defaults to 3.
fs (int, optional): [description]. Defaults to 100.
blksize (int, optional): [description]. Defaults to 10.
"""
import num... | 1,230 | 1,263 | #!/usr/bin/env python3
# Copyright (c) 2019 MindAffect B.V.
# Author: Jason Farquhar <jason@mindaffect.nl>
# This file is part of pymindaffectBCI <https://github.com/mindaffect/pymindaffectBCI>.
#
# pymindaffectBCI is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public... |
_get_slice_len | Get the number of elements in a slice.
Parameters
----------
idx : np.ndarray
A (3,) shaped array containing start, stop, step
Returns
-------
n : int
The length of the slice.
Examples
--------
>>> idx = np.array([5, 15, 5])
>>> _get_slice_len(idx)
2 | #pythran export compute_mask(int[:,:], int[:,:])
#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)
import numpy as np
def compute_mask(coords, indices): # pragma: no cover
"""
Gets the mask for the coords given the indices in sli... | def _get_slice_len(idx):
"""
Get the number of elements in a slice.
Parameters
----------
idx : np.ndarray
A (3,) shaped array containing start, stop, step
Returns
-------
n : int
The length of the slice.
Examples
--------
>>> idx = np.array([5, 15, 5])
... | 100 | 125 | #pythran export compute_mask(int[:,:], int[:,:])
#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)
import numpy as np
def compute_mask(coords, indices): # pragma: no cover
"""
Gets the mask for the coords given the indices in sli... |
_filter_pairs | Converts all the pairs into a single integer mask, additionally filtering
by the indices.
Parameters
----------
starts, stops : list[int]
The starts and stops to convert into an array.
coords : np.ndarray
The coordinates to filter by.
indices : np.ndarray
The indices in the form of slices such that indices... | #pythran export compute_mask(int[:,:], int[:,:])
#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)
import numpy as np
def compute_mask(coords, indices): # pragma: no cover
"""
Gets the mask for the coords given the indices in sli... | def _filter_pairs(starts, stops, coords, indices): # pragma: no cover
"""
Converts all the pairs into a single integer mask, additionally filtering
by the indices.
Parameters
----------
starts, stops : list[int]
The starts and stops to convert into an array.
coords : np.ndarray
... | 221 | 272 | #pythran export compute_mask(int[:,:], int[:,:])
#runas import numpy as np; coords = np.array([[0, 0, 1, 1, 2, 2]]); indices = np.array([[0, 3, 2]]); compute_mask(coords, indices)
import numpy as np
def compute_mask(coords, indices): # pragma: no cover
"""
Gets the mask for the coords given the indices in sli... |
collect_annotations | Collect the annotation information.
Args:
files (list): The list of tuples (image_file, groundtruth_file)
nproc (int): The number of process to collect annotations
Returns:
images (list): The list of image information dicts | # Copyright (c) OpenMMLab. All rights reserved.
import argparse
import math
import os
import os.path as osp
import mmcv
from mmocr.utils import convert_annotations
def collect_files(img_dir, gt_dir):
"""Collect all images and their corresponding groundtruth files.
Args:
img_dir (str): The image dir... | def collect_annotations(files, nproc=1):
"""Collect the annotation information.
Args:
files (list): The list of tuples (image_file, groundtruth_file)
nproc (int): The number of process to collect annotations
Returns:
images (list): The list of image information dicts
"""
as... | 39 | 58 | # Copyright (c) OpenMMLab. All rights reserved.
import argparse
import math
import os
import os.path as osp
import mmcv
from mmocr.utils import convert_annotations
def collect_files(img_dir, gt_dir):
"""Collect all images and their corresponding groundtruth files.
Args:
img_dir (str): The image dir... |
load_img_info | Load the information of one image.
Args:
files (tuple): The tuple of (img_file, groundtruth_file)
Returns:
img_info (dict): The dict of the img and annotation information | # Copyright (c) OpenMMLab. All rights reserved.
import argparse
import math
import os
import os.path as osp
import mmcv
from mmocr.utils import convert_annotations
def collect_files(img_dir, gt_dir):
"""Collect all images and their corresponding groundtruth files.
Args:
img_dir (str): The image dir... | def load_img_info(files):
"""Load the information of one image.
Args:
files (tuple): The tuple of (img_file, groundtruth_file)
Returns:
img_info (dict): The dict of the img and annotation information
"""
assert isinstance(files, tuple)
img_file, gt_file = files
assert osp.... | 61 | 89 | # Copyright (c) OpenMMLab. All rights reserved.
import argparse
import math
import os
import os.path as osp
import mmcv
from mmocr.utils import convert_annotations
def collect_files(img_dir, gt_dir):
"""Collect all images and their corresponding groundtruth files.
Args:
img_dir (str): The image dir... |
get_x_coordinate | Given the width of the canvas and the index of the current year
in the YEARS list, returns the x coordinate of the vertical
line associated with that year.
Input:
width (int): The width of the canvas
year_index (int): The index of the current year in the YEARS list
Returns:
x_coordinate (int): The x coordi... | """
SC101 Baby Names Project
Adapted from Nick Parlante's Baby Names assignment by
Jerry Liao.
YOUR DESCRIPTION HERE
"""
import tkinter
import babynames
import babygraphicsgui as gui
FILENAMES = [
'data/full/baby-1900.txt', 'data/full/baby-1910.txt',
'data/full/baby-1920.txt', 'data/full/baby-1930.txt',
... | def get_x_coordinate(width, year_index):
"""
Given the width of the canvas and the index of the current year
in the YEARS list, returns the x coordinate of the vertical
line associated with that year.
Input:
width (int): The width of the canvas
year_index (int): The index of the cur... | 31 | 46 | """
SC101 Baby Names Project
Adapted from Nick Parlante's Baby Names assignment by
Jerry Liao.
YOUR DESCRIPTION HERE
"""
import tkinter
import babynames
import babygraphicsgui as gui
FILENAMES = [
'data/full/baby-1900.txt', 'data/full/baby-1910.txt',
'data/full/baby-1920.txt', 'data/full/baby-1930.txt',
... |
draw_fixed_lines | Erases all existing information on the given canvas and then
draws the fixed background lines on it.
Input:
canvas (Tkinter Canvas): The canvas on which we are drawing.
Returns:
This function does not return any value. | """
SC101 Baby Names Project
Adapted from Nick Parlante's Baby Names assignment by
Jerry Liao.
YOUR DESCRIPTION HERE
"""
import tkinter
import babynames
import babygraphicsgui as gui
FILENAMES = [
'data/full/baby-1900.txt', 'data/full/baby-1910.txt',
'data/full/baby-1920.txt', 'data/full/baby-1930.txt',
... | def draw_fixed_lines(canvas):
"""
Erases all existing information on the given canvas and then
draws the fixed background lines on it.
Input:
canvas (Tkinter Canvas): The canvas on which we are drawing.
Returns:
This function does not return any value.
"""
canvas.delete('al... | 49 | 76 | """
SC101 Baby Names Project
Adapted from Nick Parlante's Baby Names assignment by
Jerry Liao.
YOUR DESCRIPTION HERE
"""
import tkinter
import babynames
import babygraphicsgui as gui
FILENAMES = [
'data/full/baby-1900.txt', 'data/full/baby-1910.txt',
'data/full/baby-1920.txt', 'data/full/baby-1930.txt',
... |
draw_names | Given a dict of baby name data and a list of name, plots
the historical trend of those names onto the canvas.
Input:
canvas (Tkinter Canvas): The canvas on which we are drawing.
name_data (dict): Dictionary holding baby name data
lookup_names (List[str]): A list of names whose data you want to plot
Return... | """
SC101 Baby Names Project
Adapted from Nick Parlante's Baby Names assignment by
Jerry Liao.
YOUR DESCRIPTION HERE
"""
import tkinter
import babynames
import babygraphicsgui as gui
FILENAMES = [
'data/full/baby-1900.txt', 'data/full/baby-1910.txt',
'data/full/baby-1920.txt', 'data/full/baby-1930.txt',
... | def draw_names(canvas, name_data, lookup_names):
"""
Given a dict of baby name data and a list of name, plots
the historical trend of those names onto the canvas.
Input:
canvas (Tkinter Canvas): The canvas on which we are drawing.
name_data (dict): Dictionary holding baby name data
... | 79 | 125 | """
SC101 Baby Names Project
Adapted from Nick Parlante's Baby Names assignment by
Jerry Liao.
YOUR DESCRIPTION HERE
"""
import tkinter
import babynames
import babygraphicsgui as gui
FILENAMES = [
'data/full/baby-1900.txt', 'data/full/baby-1910.txt',
'data/full/baby-1920.txt', 'data/full/baby-1930.txt',
... |
nick | Change an entity's nick name in a MUC room.
See: http://xmpp.org/extensions/xep-0045.html#changenick
@param roomJID: The JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param nick: The new nick name within the room.
@type nick: C{unicode} | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def nick(self, roomJID, nick):
"""
Change an entity's nick name in a MUC room.
See: http://xmpp.org/extensions/xep-0045.html#changenick
@param roomJID: The JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param nick: The new nick name... | 617 | 631 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
status | Change user status.
See: http://xmpp.org/extensions/xep-0045.html#changepres
@param roomJID: The Room JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param show: The availability of the entity. Common values are xa,
available, etc
@type show: C{unicode}
@param status: The current... | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def status(self, roomJID, show=None, status=None):
"""
Change user status.
See: http://xmpp.org/extensions/xep-0045.html#changepres
@param roomJID: The Room JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param show: The availability... | 634 | 653 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
leave | Leave a MUC room.
See: http://xmpp.org/extensions/xep-0045.html#exit
@param roomJID: The JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>} | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def leave(self, roomJID):
"""
Leave a MUC room.
See: http://xmpp.org/extensions/xep-0045.html#exit
@param roomJID: The JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
"""
occupantJID = self._roomOccupantMap[roomJID]
pre... | 656 | 669 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
getRegisterForm | Grab the registration form for a MUC room.
@param room: The room jabber/xmpp entity id for the requested
registration form.
@type room: L{JID<twisted.words.protocols.jabber.jid.JID>} | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def getRegisterForm(self, roomJID):
"""
Grab the registration form for a MUC room.
@param room: The room jabber/xmpp entity id for the requested
registration form.
@type room: L{JID<twisted.words.protocols.jabber.jid.JID>}
"""
def cb(response):
... | 729 | 744 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
register | Send a request to register for a room.
@param roomJID: The bare JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param options: A mapping of field names to values, or C{None} to
cancel.
@type options: C{dict} | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def register(self, roomJID, options):
"""
Send a request to register for a room.
@param roomJID: The bare JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param options: A mapping of field names to values, or C{None} to
cancel.
... | 747 | 761 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
configure | Configure a room.
@param roomJID: The room to configure.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param options: A mapping of field names to values, or C{None} to
cancel.
@type options: C{dict} | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def configure(self, roomJID, options):
"""
Configure a room.
@param roomJID: The room to configure.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param options: A mapping of field names to values, or C{None} to
cancel.
@type options: C{d... | 834 | 848 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
modifyAffiliationList | Modify an affiliation list.
@param roomJID: The bare JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param entities: The list of entities to change for a room.
@type entities: C{list} of
L{JID<twisted.words.protocols.jabber.jid.JID>}
@param affiliation: The affilation to the entit... | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... | def modifyAffiliationList(self, roomJID, entities, affiliation,
sender=None):
"""
Modify an affiliation list.
@param roomJID: The bare JID of the room.
@type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param entities: The lis... | 956 | 980 | # -*- test-case-name: wokkel.test.test_muc -*-
#
# Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
XMPP Multi-User Chat protocol.
This protocol is specified in
U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
"""
from dateutil.tz import tzutc
from zope.interface import implements
from twisted.inter... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.