~ubuntu-branches/ubuntu/utopic/gozerbot/utopic

« back to all changes in this revision

Viewing changes to doc/USER

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Malcolm
  • Date: 2009-09-14 09:00:29 UTC
  • mfrom: (1.1.4 upstream) (3.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090914090029-uval0ekt72kmklxw
Tags: 0.9.1.3-3
Changed dependency on python-setuptools to python-pkg-resources
(Closes: #546435) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
====
2
 
User
3
 
====
4
 
 
5
 
__copyright__ = 'this file is in the public domain'
6
 
 
7
 
 
8
 
user related commands
9
 
=====================
10
 
 
11
 
user records
12
 
~~~~~~~~~~~~
13
 
::
14
 
 
15
 
  class User(object):
16
 
  
17
 
      """ repesents a user """
18
 
  
19
 
      def __init__(self, name, userhosts, perms):
20
 
          self.name = str(name)
21
 
          self.userhosts = list(userhosts)
22
 
          self.perms = list(perms)
23
 
          self.email = ""
24
 
          self.permit = []
25
 
          self.status = []
26
 
          self.passwd = ""
27
 
          self.allowed = []
28
 
          self.notallowed = []
29
 
          self.tempuserhosts = []
30
 
          self.userdata = {}
31
 
 
32
 
every user has a name and two lists of userhosts and permissions. email can
33
 
be set and status can be used for other things than permissions for example
34
 
auto-opping is done by setting the status of a user to the channelname.
35
 
the permit list is used to allow other users access.
36
 
passwd, allowed, notallowed, tempuserhosts and userdata are not used at the
37
 
moment. the database variant has separate tables for userhosts, perms,
38
 
email, permits and status.
39
 
 
40
 
get help on the user plugin
41
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~
42
 
::
43
 
 
44
 
  < dunk> !help user
45
 
  < gozerbot> plugin description: manage users
46
 
  < gozerbot> commands: user-add .. user-addperm (addperms) .. user-addpermit
47
 
              (addpermit) .. user-addstatus (addstatus) .. user-adduserhost
48
 
              (adduserhost) .. user-allperm .. user-allstatus .. user-check
49
 
              (check) .. user-del (delete) .. user-delemail (delemail) ..
50
 
              user-delperm .. user-delstatus (delstatus) .. user-deluserhost
51
 
              (deluserhosts) .. user-deny (deny) .. user-email (email) ..
52
 
              user-getemail (+2)
53
 
  < dunk> !more
54
 
  < gozerbot>  (getemail) .. user-getname (gn) .. user-getperms (getperms) ..
55
 
              user-getstatus (getstatus) .. user-getuserhosts (getuserhosts) ..
56
 
              user-match (match) .. user-match (match) .. user-meet (meet) ..
57
 
              user-merge (merge) .. user-name (name) .. user-names (names) ..
58
 
              user-permit (permit) .. user-perms (perms) .. user-scan (us) ..
59
 
              user-search .. user-setemail (setemail) .. user-show .. (+1)
60
 
  < dunk> !more
61
 
  < gozerbot>  user-status (status) .. user-userhosts (userhosts)
62
 
 
63
 
add a new user to the database
64
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65
 
 
66
 
use a nick as argument. username is set to nickname
67
 
::
68
 
 
69
 
  < dunk> !meet dunker
70
 
  < gozerbot> dunker added to user database
71
 
 
72
 
add a new user to the database using own provided name and userhost
73
 
::
74
 
 
75
 
  < dunk> !user-add dunker bart@localhost
76
 
  < gozerbot> dunker added to user database
77
 
 
78
 
delete an user
79
 
~~~~~~~~~~~~~~
80
 
::
81
 
  
82
 
  < dunk> !delete dunk
83
 
  < gozerbot> dunk deleted
84
 
 
85
 
to see if there is already a user in the database
86
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87
 
::
88
 
 
89
 
  < dunk> !user-scan dunk
90
 
  < gozerbot> dunker
91
 
 
92
 
to add the userhost of a nick to an already available user
93
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
 
::
95
 
 
96
 
  < dunk> !merge dunker bart
97
 
  < gozerbot> bart merged
98
 
 
99
 
get the permission of a user
100
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101
 
::
102
 
 
103
 
  < dunk> !user-getperms owner
104
 
  < gozerbot> USER .. ADMIN .. MAIL .. RSS .. VOTE .. FORGET .. ALIAS .. OPER
105
 
              .. QUOTE .. SENDRAW .. SAY
106
 
 
107
 
add a permission to an user
108
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~
109
 
::
110
 
 
111
 
  < dunk> !user-addperm dunker OPER
112
 
  < gozerbot> OPER perm added
113
 
 
114
 
delete a permission from an user
115
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116
 
::
117
 
 
118
 
  < dunk> !user-delperm dunker OPER
119
 
  < gozerbot> OPER perm removed
120
 
 
121
 
the same get/set/delete commands are there for userhosts, permit and status
122
 
email, passwd can be set and unset
123
 
 
124
 
permit an other user to edit my shop list
125
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126
 
 
127
 
allow is an alias to user-addpermit
128
 
::
129
 
 
130
 
  < dunk> !allow dunk shop
131
 
  < gozerbot> permit added
132
 
 
133
 
remove a permit
134
 
~~~~~~~~~~~~~~~
135
 
 
136
 
deny is an alias to user-delpermit
137
 
::
138
 
 
139
 
  < dunk> !deny dunk shop
140
 
  < gozerbot> shop denied
141
 
 
142
 
get shop list of user if its allowed by that user
143
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144
 
::
145
 
 
146
 
  < dunk> !shop-get dunk
147
 
  < gozerbot> nothing to shop ;]
148
 
 
149
 
same can be done with todo lists