├── change-password.sh
├── mpddj_player.sh
├── README.md
├── LICENSE
└── matrix-bashbot.sh
/change-password.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | Server='https://matrix.org'
4 |
5 | read -p ' Please enter your access token: ' Token
6 | read -p ' Please enter your new password: ' PW1
7 | read -p 'Please enter your new password again: ' PW2
8 |
9 | if ! [[ $PW1 == $PW2 ]]; then
10 | echo "ERROR: NEW Passwords do not match!"
11 | exit 1
12 | fi
13 |
14 | #curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
15 | # "new_password": "TestPW"
16 | #}' 'http://localhost:8008/_matrix/client/unstable/account/password?access_token=SomeCharsThatMakeUpAnAccessToken'
17 |
18 | cat <<-EOF
19 | This script doesn't work yet.
20 | It issues the initial change password command but requires additional verification steps that have not been implemented yet.
21 | EOF
22 |
23 | Resp=`curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
24 | "new_password": "'"$PW"'"
25 | }' "$Server/_matrix/client/unstable/account/password?access_token=$Token" `
26 |
27 | jq . <<<$Resp
28 |
29 |
--------------------------------------------------------------------------------
/mpddj_player.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | source matrix-bashbot.sh
4 | mkdir -p ~/tmp
5 |
6 | clear;
7 |
8 | cat <<-EOF
9 | We update 2 playlists as you enter songs.
10 | ~/tmp/mpddj-all.playlist
11 | ~/tmp/mpddj-\$playlist.playlist
12 | where you are about to enter a value for \$playlist
13 |
14 | EOF
15 | read -e -i 'default' -p 'Please enter a playlist name: '
16 | touch ~/tmp/mpddj-${playlist:=default}.playlist
17 |
18 | clear;
19 |
20 | cat <<-EOF
21 | This script prompts you for a song URL or search string to play
22 | I then submits your entry to https://half-shot.uk/stream via
23 | matrix room !mpd:halfshot.uk
24 |
25 | enter
26 | quit: to exit
27 | next: to skip the current song
28 | skip: to skip the current song
29 |
30 |
31 | Song:
32 |
33 | EOF
34 |
35 | while true; do
36 | tput cup 10 6
37 | tput ed
38 | read -e Search
39 | tput ed
40 | echo
41 | case ${Search:-unknown} in
42 | 'quit') echo -e "\n\n";
43 | exit;;
44 | 'next') ./matrix-bashbot.sh mpddj_skip;;
45 | 'skip') ./matrix-bashbot.sh mpddj_next;;
46 | *) ./matrix-bashbot.sh mpddj_QueueSong "$Search";;
47 | esac
48 | echo
49 | echo "$Search" >> ~/tmp/mpddj-$playlist.playlist
50 | echo "$Search" >> ~/tmp/mpddj-all.playlist
51 | for i in {10..1}; do echo -en "\r $i "; sleep 1; done
52 | done
53 |
54 |
55 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # matrix_bash_bot
2 | matrix.org Bash Bot
3 |
4 | A Semi-Stateless Matrix Bot written in Bash
5 | It depends on bash, curl and jq
6 |
7 | It is currently far from complete, but is usable to Login, Join a Room, and Send a message to that room
8 | In theory, you can also register a new user, although this function is untested
9 |
10 | Receiving messages is being worked on at the moment.
11 |
12 | Other functions will be added when I need them or someone else contributes them.
13 |
14 | Some state is stored in /tmp so that consecutive runs don't need to re-login and re-join rooms.
15 | This allows sending of multiple messages with a simple SendMessage command.
16 | There is an assumption made here, there will only be one Login Name and one ROOM in use by any System User.
17 | This is due to the state file being stored in a directory named with the System User appended.
18 |
19 |
20 | Function List
21 | ----------------------------------------------------------------------------------------------------------
22 | : ######################################################################################
23 | : ######################################################################################
24 | : USAGE: matrix-bashbot.sh Option|Command [ARG1 [ARG2]]
25 | : Options
26 | : -v --version : script Version
27 | : -h --help : this help
28 | : ######################################################################################
29 | : ######################################################################################
30 | : ######################################################################################
31 | : ######################################################################################
32 | : Configuration and Stored State are first obtained from the defaults in the script
33 | : Then read from ~/.matrix-bash-bot.rc
34 | : NOTE: the location of the rc file can be overridden by setting environment variable
35 | : matrix_bash_bot_rc
36 | : before running or sourcing matrix-bashbot.sh
37 | : Then read from $StateFile
38 | : Each source overrides the previous one.
39 | : $StateFile is stored in /tmp and is normally deleted on reboot
40 | : any state_ variables can be stored in ~/.matrix-bash-bot.rc to provide defaults after a reboot.
41 | : but beware, if you do this with the TOKENS and later run the LOGIN function you will
42 | : need to manually update them otherwise a subsequent reboot will end up using the wrong TOKENS
43 | : A better way of handling this is to make sure you do a login after every reboot.
44 | : Eventually we will test for an empty TOKEN every time the script is run, and do an auto login.
45 | : ######################################################################################
46 | : ######################################################################################
47 |
48 | DIE : $1 = short message $2 = detail
49 | : print a loud error message and exit
50 |
51 | clear_State : clear all stored state
52 | : if the state is stored in /tmp (the default) then it would normally be cleared on reboot as well
53 |
54 | dump_Functions : Dump a help style list of functions and Comments starting with ##
55 | : to get a function name to be dumped you need to follow the form, foo() ## comment
56 | : All lines that start with "[[:space:]]*## " will be included regardless of being inside a function or not
57 |
58 | HELP : This Help Message
59 | : print help and current state
60 | : Run this with -h --help or HELP
61 |
62 | WRITE_README : Update the README.md file
63 |
64 | VERSION : Display the current version of this script
65 | : Run this with -V --version or VERSION
66 |
67 | test_rawurlencode : test the rawurlencode() function, prints the result as well as putting it in $URLstring
68 | : $1 is the String to Encode
69 |
70 | Register : Register a new username.
71 | : Username is read from "$StateFile" [default: /tmp/matrixbashbot-$USER/state-vars ]
72 | : Password is currently stored in this script,
73 | : but will soon be read from stdin instead
74 | : Should only be called once for a username.
75 | : ######################################################
76 | : WARNING fixme this function is untested use with caution
77 | : ######################################################
78 |
79 | LogIn : Login to get an access token for your username
80 | : the token can be reused essentially forever.
81 | : Username is read from "$StateFile" [default: /tmp/matrixbashbot-$USER/state-vars ]
82 | : Password is currently stored in this script,
83 | : but will soon be read from stdin instead
84 |
85 | JoinRoom : $1 is room name
86 | : joins the given room, appends the home_server (likely :matrix.org) if none is provided
87 | : in most cases the room will already be joined, in that case, this function
88 | : primarily is used to change the roomID which is used for all other actions
89 |
90 | SendMessage : $1 is message to send
91 | : send a text string to the currently selected room
92 | : a default test string with appended date will be used if no string supplied.
93 |
94 | mpddj : $@ command to send to mpddj
95 | : NOTE: all mpddj* commands use a fixed room !mpd:half-shot.uk
96 | : skip the currently playing song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
97 | : ping Ping the server and get the delay.
98 | : current Get the current song title.
99 | : next Skip current song.
100 | : help This help text.
101 | : search Get the first youtube result by keywords.
102 | : [url] Type a youtube/soundcloud/file url in to add to the playlist.
103 | : stream Get the url of the stream.
104 | : playlist Display the the shortened playlist.
105 |
106 | mpddj_QueueSong : $1 is message to send
107 | : queue a song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
108 | : a default song will be selected if you don't enter one
109 | : if a url is supplied containing http: or https: then it will attempt to play that URL
110 | : otherwise it will ask mpddj to search for the song.
111 |
112 | mpddj_next : no arguments
113 | : skip the currently playing song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
114 |
115 | mpddj_skip : no arguments
116 | : skip the currently playing song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
117 |
118 | SetIrcTopic : This is a crude hack that bypasses setting the matrix topic
119 | : and directly tries setting the topic on the IRC side of the bridge.
120 | : of course this will only work if your matrix (IRC side) user has OPs
121 | : or the channel does not have +t set
122 | : on bridged channels, you would normally not have ROOM power to let you change the topic
123 | : $1 is new topic
124 |
125 | SetTopic : change the topic in the matrix room
126 | : may aslo change the topic for bridged channels in both matrix and IRC but it is unlikely
127 | : as you normally don't have power on the matrix side which will block both sides of the bridge from changing
128 | : on bridged channels, you would normally not have ROOM power to let you change the topic
129 | : $1 is new topic
130 |
131 | GetInitialSync : retrieves initialSync date with limit=1 and stores it in /tmp/matrixbashbot-$USER/state-initial-sync
132 | : for now nothing else is done with the data, it is just stored in the file
133 |
134 | GetRecentEvents : this is broken for now, should return the last X events in the current room
135 | : ######################################################
136 | : WARNING fixme this function is untested use with caution
137 | : ######################################################
138 |
139 | DoSync : runs a sync from the last known event time
140 | : ######################################################
141 | : WARNING fixme this function is untested use with caution
142 | : ######################################################
143 |
144 | GetPushRules : dump the current PushRules to stdout as formatted JSON
145 |
146 | GetRoomState : dump the current Roomstate to stdout as formatted JSON
147 |
148 | SampleGets : some sample gets that don't need authentication
149 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/matrix-bashbot.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | # sure. just grab them out of the network inspector in Chrome or Firefox
4 | # you find the request (search for 'login' or 'm14' for login & message respectively)
5 | # and right-click and copy as curl
6 |
7 | # If you want a doc, there's http://matrix.org/docs/howtos/client-server.html
8 | # Another option is to go into the browser console and type localStorage.getItem("mx_access_token")
9 |
10 | ## ########################################################################################
11 | ## ########################################################################################
12 | ##
13 | ## USAGE: matrix-bashbot.sh Option|Command [ARG1 [ARG2]]
14 | ##
15 | ## Options
16 | ## -v --version : script Version
17 | ## -h --help : this help
18 | ##
19 | ## ########################################################################################
20 | ## ########################################################################################
21 |
22 | VERBOSE="${VERBOSE:-false}"
23 | # #####################
24 | # These variables should be set in ~/.matrix-bash-bot.rc
25 | # DO NOT SET THEM IN THIS FILE !!!! It would be a security risk to do so
26 | # #####################
27 | userNAME='username'
28 | userPASSWORD='password'
29 |
30 | # #####################
31 | # These variables can either be set here or in ~/.matrix-bash-bot.rc
32 | # #####################
33 | # default TOPIC to use when changing topic
34 | # _DATE_ will be replaced with the result of the date command
35 | TOPIC="set by Matrix BashBot at _DATE_"
36 |
37 | # #####################
38 | # These variables are automatically maintained by the script and stored in $StateFile
39 | # #####################
40 | state_roomNAME='#test-bot:matrix.org'
41 | state_baseURL='https://matrix.org/_matrix/client'
42 | state_roomID='!ewOgZEUrOZAAaQJNBv:matrix.org'
43 | state_msgID='x'
44 | state_txnID=1
45 |
46 | state_home_server="matrix.org"
47 | #state_user_id="@user:matrix.org"
48 |
49 | state_accessTOKEN='xxxxxx'
50 | state_refreshTOKEN='xxxxxx'
51 |
52 | ## ########################################################################################
53 | ## ########################################################################################
54 | ## .
55 | ## Configuration and Stored State are first obtained from the defaults in the script
56 | ## Then read from ~/.matrix-bash-bot.rc
57 | ## NOTE: the location of the rc file can be overridden by setting environment variable
58 | ## MATRIXBASHBOT_RC
59 | ## before running or sourcing matrix-bashbot.sh
60 | ## Then read from $StateFile
61 | ## Each source overrides the previous one.
62 | ## .
63 | ## $StateFile is stored in /tmp and is normally deleted on reboot
64 | ## any state_ variables can be stored in ~/.matrix-bash-bot.rc to provide defaults after a reboot.
65 | ## but beware, if you do this with the TOKENS and later run the LOGIN function you will
66 | ## . need to manually update them otherwise a subsequent reboot will end up using the wrong TOKENS
67 | ## . A better way of handling this is to make sure you do a login after every reboot.
68 | ## . Eventually we will test for an empty TOKEN every time the script is run, and do an auto login.
69 | ## .
70 | ## ENVIRONMENT VARIABLES
71 | ## . MATRIXBASHBOT_RC - Override the RC file location (~/.matrix-bash-bot.rc)
72 | ## . MATRIXBASHBOT_RC_OVERLAY - The RC file gets loaded first, then this file allows overrides by simply
73 | ## . reassigning variables
74 | ## . MATRIXBASHBOT_INSTANCE - Append an instance name to the $StateFile DIR (/tmp/matrixbashbot-$USER)
75 | ## . so it looks like /tmp/matrixbashbot-$USER-$MATRIXBASHBOT_INSTANCE
76 | ## .
77 | ## ########################################################################################
78 | ## ########################################################################################
79 |
80 | DIE() { ## $1 = short message $2 = detail
81 | ## print a loud error message and exit
82 | cat <<-EOF
83 | ==================================
84 | ==================================
85 | ==== ERROR ERROR ERROR ERROR ====
86 | ==================================
87 | ==================================
88 | ==== ====`echo $'\r'`==== $1
89 | ==================================
90 | $2
91 | ==================================
92 | ==================================
93 |
94 | EOF
95 | exit
96 | }
97 |
98 | vecho() {
99 | $VERBOSE && echo $@
100 | }
101 |
102 | read COLUMNS < <(tput cols)
103 | export COLUMNS
104 |
105 | # #####################
106 | # Work out if we were executed or sourced
107 | # and if sourced make sure it was from a bash shell
108 | # #####################
109 | if [[ ${FUNCNAME[0]} == "source" ]]; then SOURCED=true; else SOURCED=false; fi
110 |
111 | ScriptName="${ARGV:-$0}"
112 | if [[ ${BASH##*/} != "bash" ]]; then
113 | echo "This script '$ScriptName' is intended to only be run from bash"
114 | exit 1
115 | fi
116 |
117 | # #####################
118 | # Check for Args and warn if non available
119 | # #####################
120 | if [[ -z $1 ]] && ! $SOURCED; then
121 | cat <<-EOF
122 |
123 | ===============================================================
124 | == You probably want to run this with at least one argument ==
125 | ===============================================================
126 | == -h or --help will show you available arguments ==
127 | ===============================================================
128 |
129 | EOF
130 | fi
131 |
132 | # #####################
133 | # Read User Config
134 | # #####################
135 | rcFile="${MATRIXBASHBOT_RC:=$HOME/.matrix-bash-bot.rc}";
136 | if [[ -r "$rcFile" ]]; then
137 | source "$rcFile"; # read local config from file
138 | chmod 600 "$rcFile" || { DIE "'$ScriptName' said" "failed to own my RC file ($rcFile)"; exit; } # force it to only be readable/writeable by owner
139 | fi
140 |
141 | # Read User Config Overlay
142 | rcFile_overlay="${MATRIXBASHBOT_RC_OVERLAY}";
143 | if [[ -r "$rcFile_overlay" ]]; then
144 | source "$rcFile_overlay"; # read local config from file
145 | chmod 600 "$rcFile_overlay" || { DIE "'$ScriptName' said" "failed to own my rc overlay file ($rcFile_overlay)"; exit; } # force it to only be readable/writeable by owner
146 | fi
147 |
148 | StateDir="/tmp/matrixbashbot-$USER${MATRIXBASHBOT_INSTANCE:+-$MATRIXBASHBOT_INSTANCE}"
149 | StateFile="$StateDir/state-vars"
150 | File_InitialSync="$StateDir/state-initial-sync"
151 | mkdir -p "$StateDir"
152 |
153 | if [[ ! -r $StateFile ]]; then
154 | chown -R $USER:$USER "$StateDir/" || { DIE "'$ScriptName' said" "failed to own my state file ($StateFile)"; exit; }
155 | fi
156 |
157 | # #####################
158 | # Load stored state from file
159 | # #####################
160 | if [[ -r $StateFile ]]; then
161 | vecho "reading statefile"
162 | chmod 600 $StateFile # force it to only be readable/writeable by owner
163 | source "$StateFile"
164 | else
165 | echo "statefile is missing"
166 | fi
167 |
168 | # #####################
169 | # Report Config and State Load Order
170 | # #####################
171 | $VERBOSE && cat <<-EOF
172 | **********************************************
173 | ** Loaded Config and state from these files
174 | ** $rcFile
175 | ** $rcFile_overlay
176 | ** $StateFile
177 | **********************************************
178 | EOF
179 |
180 | #state_txnID=1
181 | MSG='Test from matrix bashbot';
182 | #curl 'https://matrix.org/_matrix/client/r0/rooms/!cURbafjkfsMDVwdRDQ%3Amatrix.org/send/m.room.message/m1455740925390?access_token=censored' \
183 | # -X PUT --data-binary '{"msgtype":"m.text","body":"sure. just grab them out of the network inspector in Chrome or Firefox"}'
184 |
185 | if [[ ! -x `which jq` ]]; then
186 | if [[ -e `which apt-get` ]]; then
187 | echo -e " Required tool 'jq' is not available.\n Installing it now\n";
188 | sudo apt-get install jq;
189 | else
190 | echo "Please install Required tool 'jq' then return here and"
191 | read -p 'Press Enter to continue'
192 | fi
193 | # check again now that we have theoretically installed jq
194 | if [[ ! -x `which jq` ]]; then DIE "jq is not available" "Please install 'jq' and Re-Run this script"; exit; fi
195 | fi
196 |
197 | dump_State() {
198 | echo -e '\n\nCurrent State is'
199 | for var in ${!state_@}; do
200 | _val="${!var}"
201 | if [[ $var =~ 'TOKEN' ]]; then
202 | if (( ${#_val} > 20 )); then _t="${_val: -10}"; _val="${_val:0:10}....$_t"; fi
203 | fi
204 | printf " %12s = %s\n" "${var#state_}" "$_val"
205 | done
206 | echo
207 | }
208 |
209 | store_State() {
210 | vecho -e '\n\nStoring Current State'
211 | echo -n > "$StateFile"
212 | if [[ ! -w "$StateFile" ]]; then echo "statefile not writeable"; fi
213 | for var in ${!state_@}; do
214 | _val="${!var}"
215 | if [[ $var =~ 'TOKEN' ]]; then
216 | if (( ${#_val} > 20 )); then _t="${_val: -10}"; _val="${_val:0:10}....$_t"; fi
217 | fi
218 | $VERBOSE && printf " %12s = %s\n" "${var#state_}" "$_val"
219 | printf "%s=\"%s\"\n" "${var}" "${!var}" >> "$StateFile"
220 | done
221 | vecho
222 | }
223 |
224 | clear_State() { ## clear all stored state
225 | ## if the state is stored in /tmp (the default) then it would normally be cleared on reboot as well
226 | echo -n "Clearing Stored State: "
227 | if rm "$StateFile" 2>/dev/null; then echo "DONE"; else echo "FAILED"; fi
228 | }
229 |
230 | dump_Functions() { ## Dump a help style list of functions and Comments starting with ##
231 | ## to get a function name to be dumped you need to follow the form, foo() { ## comment
232 | ## All lines that start with "[[:space:]]*## " will be included regardless of being inside a function or not
233 | while read -t10 F D; do # find max length of any function name
234 | F="${F#\#\#}"; F="${F/()/}";
235 | if (( ${#F} > _len )); then _len=${#F}; fi
236 | done < <(egrep '[a-zA-Z0-9_]+[(][)] {|^[[:space:]]*##' $0)
237 |
238 | if [[ $0 =~ --README ]] || [[ $@ =~ --README ]]; then
239 | (( _wrap_len = 109 - _len - 7)); # this hopefully is optimal for viewing on GITHUB without scrollbars
240 | else
241 | (( _wrap_len = COLUMNS - _len - 7 )); # wrap dynamically based on screen width
242 | fi
243 |
244 | echo -en '\n Function List'
245 | printf "\n%1.*s\n" $(( _wrap_len + _len + 6 )) ' ----------------------------------------------------------------------------------------------------------'
246 | while read -t10 F D; do
247 | F="${F#\#\#}";
248 | F="${F/()/}";
249 | D="${D/{/}"
250 | D=${D# }
251 | D="${D#\#}"
252 | D="${D#\#}"
253 | D="${D# }"
254 | if [[ -n $F ]]; then echo; fi
255 |
256 | # print Line wrapped to 80 chars
257 | while (( ${#D} > _wrap_len )); do
258 | D1="${D:0:$_wrap_len}"; # clip Line to 80 chars
259 | DlastWord="${D1##*[ #]}"; # save the last word on this line
260 | if (( ${#DlastWord} >= _wrap_len )); then # if we have a lastword that is all of the line then don't wrap it
261 | DlastWord=' ';
262 | else
263 | DlastWord="${DlastWord:0:$_wrap_len}";
264 | fi
265 | D1="${D1%[ #]*}"; # strip the last word off of line 1 (use space as a delimiter)
266 | D="${DlastWord:0:80}${D:$_wrap_len}"; # prune the first 80 chars from the buffer and prepend the last word from previous line
267 | printf " %-*s : %s\n" $_len "$F" "${D1% }";
268 | F=''; # only print the function name for the first line
269 | if [[ "$D1" =~ "#${D:0:$_wrap_len}" ]]; then # if the remaining buffer starts with a # and is a perfect subset of the last line printed just drop it
270 | D=''; # drop the line as it's almost certainly just a series of #'s and either way it already exists on the line above
271 | else
272 | D=" $D"; # provide an indent of 4 for wrapped lines
273 | fi
274 | done
275 | if [[ -n $D ]]; then
276 | printf " %-*s : %s\n" $_len "$F" "${D}";
277 | fi
278 |
279 | done < <(egrep '[a-zA-Z0-9_]+[(][)] { ?##|^[[:space:]]*##' $0)
280 | }
281 |
282 | HELP() { ## This Help Message
283 | ## print help and current state
284 | ## Run this with -h --help or HELP
285 | clear;
286 | dump_State;
287 | dump_Functions;
288 | # dump_Functions --README;
289 | # ( declare -p )
290 | # set -o posix
291 | # echo 'Current Config is'
292 | # set
293 | cat <<-EOF
294 |
295 |
296 |
297 | EOF
298 | exit
299 | }
300 |
301 | WRITE_README() { ## Update the README.md file
302 | cat <<-EOF >README.md
303 | # matrix_bash_bot
304 | matrix.org Bash Bot
305 |
306 | A Semi-Stateless Matrix Bot written in Bash
307 | It depends on bash, curl and jq
308 |
309 | It is currently far from complete, but is usable to Login, Join a Room, and Send a message to that room
310 | In theory, you can also register a new user, although this function is untested
311 |
312 | Receiving messages is being worked on at the moment.
313 |
314 | Other functions will be added when I need them or someone else contributes them.
315 |
316 | Some state is stored in /tmp so that consecutive runs don't need to re-login and re-join rooms.
317 | This allows sending of multiple messages with a simple SendMessage command.
318 | There is an assumption made here, there will only be one Login Name and one ROOM in use by any System User.
319 | This is due to the state file being stored in a directory named with the System User appended.
320 |
321 | EOF
322 | dump_Functions >> README.md
323 | }
324 |
325 | if ! $SOURCED && { [[ $@ =~ -h ]] || [[ $@ =~ --help ]]; } ; then HELP; fi
326 |
327 | VERSION() { ## Display the current version of this script
328 | ## Run this with -V --version or VERSION
329 | cat <<-EOF
330 |
331 | ===================================================
332 | ===================================================
333 | ==== Version: $Version
334 | ==== CopyRight: SB Tech Services (David G) 2016
335 | ==== Author: David G
336 | ==== matrix id: sbts_mx:matrix.org
337 | ==== matrix room: #sbts:matrix.org
338 | ===================================================
339 | ===================================================
340 |
341 | EOF
342 | exit
343 | }
344 | if [[ $@ =~ -V ]] || [[ $@ =~ --version ]]; then VERSION; fi
345 | if [[ $@ =~ -v ]] || [[ $@ =~ --verbose ]]; then VERBOSE='true'; fi
346 |
347 | rawurlencode() { # URL encode $1
348 | # Result is returned in $URLstring
349 | local string="${1}"
350 | local strlen=${#string}
351 | local encoded=""
352 |
353 | for (( pos=0 ; pos /tmp/matrix-bashbot-mpddj.err 2>&1 && echo "success" || {
490 | echo "Sending command failed!"
491 | cat /tmp/matrix-bashbot-mpddj.err
492 | }
493 | }
494 | mpddj_QueueSong() { ## $1 is message to send
495 | ## queue a song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
496 | ## a default song will be selected if you don't enter one
497 | ## if a url is supplied containing http: or https: then it will attempt to play that URL
498 | ## otherwise it will ask mpddj to search for the song.
499 | if [[ $1 =~ 'https?:' ]]; then
500 | _MSG+="${@:-search lily allen fuck you}";
501 | else
502 | _MSG+="search ${@:-lily allen fuck you}";
503 | fi
504 | mpddj "$_MSG";
505 | }
506 |
507 | mpddj_next() { ## no arguments
508 | ## skip the currently playing song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
509 | mpddj next;
510 | }
511 | mpddj_skip() { ## no arguments
512 | ## skip the currently playing song on http://half-shot.uk/stream via mpddj in room mpd:half-shot.uk
513 | mpddj next;
514 | }
515 |
516 | SetIrcTopic() { ## This is a crude hack that bypasses setting the matrix topic
517 | ## and directly tries setting the topic on the IRC side of the bridge.
518 | ## of course this will only work if your matrix (IRC side) user has OPs
519 | ## or the channel does not have +t set
520 | ## on bridged channels, you would normally not have ROOM power to let you change the topic
521 | ## $1 is new topic
522 | _MSG="${1:-$TOPIC}"
523 | _MSG="${_MSG/_DATE_/`date`}"
524 | state_txnID="`date "+%s"`$(( RANDOM % 9999 ))"
525 | echo "Setting TOPIC to '$_MSG' on IRC side of $state_roomNAME"
526 | # This one changes the topic in a bridged IRC channel (if you have rights to do so), but not the matrix room
527 | curl "$state_baseURL/r0/rooms/$state_roomID/send/m.room.topic/$state_txnID?access_token=$state_accessTOKEN" -X PUT --data-binary '{"topic":"'"$_MSG"'"}'
528 | }
529 |
530 | SetTopic() { ## change the topic in the matrix room
531 | ## may aslo change the topic for bridged channels in both matrix and IRC but it is unlikely
532 | ## as you normally don't have power on the matrix side which will block both sides of the bridge from changing
533 | ## on bridged channels, you would normally not have ROOM power to let you change the topic
534 | ## $1 is new topic
535 | _MSG="${1:-$TOPIC}"
536 | _MSG="${_MSG/_DATE_/`date`}"
537 | state_txnID="`date "+%s"`$(( RANDOM % 9999 ))"
538 | echo "Setting TOPIC to '$_MSG' on $state_roomNAME"
539 | # This one changes the topic in a bridged IRC channel (if you have rights to do so), but not the matrix room
540 | #curl "$state_baseURL/r0/rooms/$state_roomID/send/m.room.topic/$state_txnID?access_token=$state_accessTOKEN" -X PUT --data-binary '{"topic":"'"$_MSG"'"}'
541 | #this one changes the topic in the matrix room
542 | curl "$state_baseURL/r0/rooms/$state_roomID/state/m.room.topic?access_token=$state_accessTOKEN" -X PUT --data-binary '{"topic":"'"$_MSG"'"}'
543 | #echo curl "https://matrix.org/_matrix/client/r0/rooms/!BMQUkvgMwJuteJuqOD%3Amatrix.org/state/m.room.topic?access_token=$state_accessTOKEN" \
544 | # -X PUT -H 'Host: matrix.org' \
545 | # -H 'User-Agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:43.0) Gecko/20100101 Firefox/43.0' \
546 | # -H 'Accept: application/json' \
547 | # -H 'Accept-Language: en-US,en;q=0.5' \
548 | # --compressed \
549 | # -H 'Content-Type: application/json; charset=UTF-8' \
550 | # -H 'Referer: https://vector.im/develop/' \
551 | # -H 'Origin: https://vector.im' \
552 | # -H 'Connection: keep-alive' \
553 | # --data '{"topic":"test topic"}'
554 | }
555 |
556 | SetFilter() {
557 |
558 | cat <<-EOF
559 | look at this http://matrix.org/docs/spec/r0.0.1/client_server.html#filtering
560 | the main way that filters are used today is to apply limits
561 | e.g. my vector right here is using {"room":{"timeline":{"limit":20}}}
562 | based on
563 | curl 'https://matrix.org/_matrix/client/r0/user/@matthew:matrix.org/filter/21?access_token=secret'
564 | filter number 21 having been pulled out of looking at what it's using in a /sync request
565 | EOF
566 | }
567 |
568 | GetInitialSync() { ## retrieves initialSync date with limit=1 and stores it in /tmp/matrixbashbot-$USER/state-initial-sync
569 | ## for now nothing else is done with the data, it is just stored in the file
570 | # curl -XGET "http://localhost:8008/_matrix/client/api/v1/initialSync?limit=1&access_token=YOUR_ACCESS_TOKEN"
571 | echo curl --silent -XGET "$state_baseURL/api/v1/initialSync?limit=1&access_token=$state_accessTOKEN"
572 | curl --silent -XGET "$state_baseURL/api/v1/initialSync?limit=1&access_token=$state_accessTOKEN" > "$File_InitialSync"
573 | echo "==========================="
574 | echo "==========================="
575 | echo "==== results are in ===="
576 | echo "==========================="
577 | echo "$File_InitialSync"
578 | echo "==========================="
579 | echo "==========================="
580 | echo "==== try running ===="
581 | echo -e " jq .rooms \"$File_InitialSync\""
582 | # echo "==== json ===="
583 | # jq . "$File_InitialSync"
584 | }
585 |
586 | GetRecentEvents() { ## this is broken for now, should return the last X events in the current room
587 | ##
588 | ## ########################################################
589 | ## WARNING fixme this function is untested use with caution
590 | ## ########################################################
591 | ##
592 | # curl -XGET "http://localhost:8008/_matrix/client/api/v1/initialSync?limit=1&access_token=YOUR_ACCESS_TOKEN"
593 | echo curl --silent -XGET "$state_baseURL/api/v1/initialSync?limit=1&access_token=$state_accessTOKEN"
594 | resp=`curl --silent -XGET "$state_baseURL/api/v1/initialSync?limit=1&access_token=$state_accessTOKEN"`
595 | echo "==== raw ===="
596 | echo -e "$resp"
597 | echo "==== json ===="
598 | jq . /dev/stdin <<<$resp
599 | }
600 |
601 | ConvertAgeToTime() {
602 | date -u -d @${1} +"%T"
603 | }
604 |
605 | ConvertTSToDateTime() {
606 | date -u -d @${1} +"%F-%T"
607 | }
608 |
609 | xMinifyJSON() { :; } # use this to disable a JSON blob that comes after the one you want to use
610 | MinifyJSON() { ## for now just Squashes multiple spaces together. #FIXME: be smarter, including removal of cr/lf etc
611 | local -g RESULTstring="${1// / }";
612 | while [[ "$RESULTstring" =~ ' ' ]]; do
613 | RESULTstring="${RESULTstring// / }";
614 | done
615 | while [[ "$RESULTstring" =~ $'\r' ]]; do
616 | RESULTstring="${RESULTstring//$'\r'/}";
617 | done
618 | while [[ "$RESULTstring" =~ $'\n' ]]; do
619 | RESULTstring="${RESULTstring//$'\n'/}";
620 | done
621 | }
622 |
623 | GetEvents_m_room_message() { ## $1 # last ${1:-1000} events in the current room.
624 | ## $2 # starting from the latest event specified by ${2:-END}
625 | ## $3 # a json list containing senders to exclude.
626 | ## eg: '"@_neb_github_=40john=3amatrix.freelock.com:matrix.org", "@someuser:matrix.org"'
627 | ## defaults to '"@_neb_github_=40john=3amatrix.freelock.com:matrix.org"'
628 | ##
629 | ## ########################################################
630 | ## WARNING fixme this function is untested use with caution
631 | ## ########################################################
632 | ##
633 | hideToken='hidden' ## comment this out to show the access token in verbose output
634 | local _From="${2:-END}"; # Token to use for first event to retrieve. Can be 'END' or the token returned in "start" or "end" paramater by a previous request
635 | local _Dir='b'; # one of 'b' or 'f'. changes direction to retrieve in relation to "from"
636 | local _Limit=${1:-1000}; # maximum number of events to return
637 | local _Not_Users="${3:-\"@_neb_github_=40john=3amatrix.freelock.com:matrix.org\"}"
638 | # a filter to use. This '{"contains_url":true}' only returns events that contain url's # See http://matrix.org/speculator/spec/HEAD/client_server/unstable.html#filtering
639 | # another example filter https://github.com/turt2live/matrix-voyager-bot/blob/master/src/matrix/filter_template.json
640 | # this filter doesn't work as expected. the content.msgtype part is ignored
641 | # MinifyJSON '{
642 | # "types": ["m.room.message"],
643 | # "not_senders": ["@_neb_github_=40john=3amatrix.freelock.com:matrix.org"],
644 | # "content": {
645 | # "msgtype": ["m.text"]
646 | # }
647 | # }';
648 | MinifyJSON '{
649 | "types": ["m.room.message"],
650 | "not_senders": ['${_Not_Users}']
651 | }';
652 | rawurlencode "${RESULTstring}"
653 | local _Filter="${URLstring}"
654 |
655 | vecho "curl --silent -XGET \"$state_baseURL/api/v1/rooms/$state_roomID/messages?access_token=${hideToken:-$state_accessTOKEN}&from=${_From}&dir=${_Dir}&limit=${_Limit}${RESULTstring:+&filter=}${RESULTstring}\"" >/dev/stderr
656 | resp=` curl --silent -XGET "$state_baseURL/api/v1/rooms/$state_roomID/messages?access_token=$state_accessTOKEN&from=${_From}&dir=${_Dir}&limit=${_Limit}${_Filter:+&filter=}${_Filter}"`
657 | vecho "==== raw ====" >/dev/stderr
658 | # echo -e "$resp" > /tmp/raw.json.echo # DON'T do it this way. the -e swallows some \ escapes which can result in invalid json
659 | printf "%s" "$resp" > /tmp/raw.json
660 | vecho "== Raw output written to /tmp/raw.json ==" >/dev/stderr
661 | vecho "==== json ====" >/dev/stderr
662 | jq . /dev/stdin <<<$resp
663 | # jq -r '.chunk[] | select(.age < 86400000) | "\(.age) \(.user_id)"' /dev/stdin <<<$resp
664 | # jq -r '.chunk[] | select( .content.msgtype == "m.text" ) | select(.age < 86400000) | "\(.age) \(.user_id) \(.content.body)"' /dev/stdin <<<$resp
665 | }
666 |
667 | GetEventLog_24_Hrs() { ## return the last 24 hours of events
668 | # FIXME we want to test for jq version >=1.5 then we can use date conversions like....
669 | # jq --arg date "2016-04-25" '.[].published_at |= (. / 1000 | strftime("%Y-%m-%d")) | map(select(.published_at == $date))' stuff.json
670 | local _minAge=0 # seconds
671 | local _maxAge=86400 # seconds
672 | GetEvents_m_room_message 1000 >/dev/null
673 | jq -r --arg maxAge "$_maxAge" '.chunk[] | select( .content.msgtype == "m.text" ) | select(.age < ( $maxAge | tonumber) *1000) | @sh "\(.origin_server_ts/1000) \(.user_id) \(.content.body)"' /dev/stdin <<<$resp # NOTE .age/1000 to convert it to seconds
674 | jq -r --arg maxAge "$_maxAge" '.chunk[] | select( .content.msgtype == "m.text" ) | select(.age < ( $maxAge | tonumber) *1000) | length' /dev/stdin <<<$resp | wc -l
675 | }
676 |
677 | DoSync() { ## runs a sync from the last known event time
678 | ##
679 | ## ########################################################
680 | ## WARNING fixme this function is untested use with caution
681 | ## ########################################################
682 | ##
683 | _since=$state_next_batch
684 | # _filter='{room{include_leave: "false", account_data:"", timeline:"", ephemeral:"", state:"", not_rooms:"", rooms:"'"$state_roomID"'" }}'
685 | # rawurlencode '{"room":{"timeline":{"limit":1}}}'
686 | # rawurlencode '{
687 | # "event_fields":"content.body",
688 | # "room":{
689 | # "include_leave": "false",
690 | # "timeline":{"limit":1},
691 | # "rooms":"'"$state_roomID"'"
692 | # }
693 | # }'
694 | # rawurlencode '{"event_fields":"content.body", "room":{"include_leave": "false", "timeline":{"limit":1}, "rooms":"'"$state_roomID"'"}}'
695 | # rawurlencode '{"presence":{"types":[]}, "event_fields":["content.body"], "room":{"state":{"types":[]}, "timeline":{"limit":1}, "rooms":["'"$state_roomID"'"]}}'
696 | #rawurlencode '{
697 | # "account_data":{"types":[]},
698 | # "presence":{"types":[]},
699 | # "event_fields":["timeline"],
700 | # "room":{
701 | # "timeline":{"limit":1},
702 | # "rooms":["!pstlCRlhnmqaJggfOM:matrix.org"]
703 | # }
704 | #}'
705 |
706 | # rawurlencode '{
707 | # "room": {
708 | # "state": {
709 | # "types": ["m.room.*"],
710 | # "not_rooms": ["!726s6s6q:example.com"]
711 | # },
712 | # "timeline": {
713 | # "limit": 2,
714 | # "types": ["m.room.message"],
715 | # "not_rooms": ["!726s6s6q:example.com"],
716 | # "not_senders": ["@spam:example.com"]
717 | # "rooms":["!pstlCRlhnmqaJggfOM:matrix.org"]
718 | # },
719 | # "ephemeral": {
720 | # "types": [ "m.receipt", "m.typing"],
721 | # "not_rooms": ["!726s6s6q:example.com"],
722 | # "not_senders": ["@spam:example.com"]
723 | # }
724 | # },
725 | # "presence": {
726 | # "types": ["m.presence"],
727 | # "not_senders": ["@alice:example.com"]
728 | # },
729 | # "event_format": "client",
730 | # "event_fields": ["type", "content", "sender"]
731 | # }'
732 |
733 | # "rooms":"'"$state_roomID"'"
734 | rawurlencode '{
735 | "room": {
736 | "include_leave": "false",
737 | "account_data": {},
738 | "state": {
739 | "types": [],
740 | "rooms": []
741 | },
742 | "timeline": {
743 | "limit": 2,
744 | "types": ["m.room.message"],
745 | "rooms":["!pstlCRlhnmqaJggfOM:matrix.org"]
746 | },
747 | "ephemeral": {
748 | "types": []
749 | }
750 | },
751 | "event_format": "client",
752 | "event_fields": ["type", "content.msgtype", "content.body", "sender"],
753 | "account_data":{
754 | "types": [],
755 | },
756 | "presence":{
757 | "types": [],
758 | }
759 | }'
760 | _filter="$URLstring"
761 | curl -XGET "$state_baseURL/r0/sync?filter=$_filter&timeout=30000&access_token=$state_accessTOKEN" > "$File_InitialSync"
762 | echo "==========================="
763 | echo "==========================="
764 | echo "==== results are in ===="
765 | echo "==========================="
766 | echo "$File_InitialSync"
767 | echo "==========================="
768 | echo "==========================="
769 | echo "==== try running ===="
770 | echo -e " jq .rooms \"$File_InitialSync\""
771 | echo "==========================="
772 |
773 | # jq -C .rooms "$File_InitialSync"
774 |
775 |
776 | # curl "https://matrix.org/_matrix/client/r0/sync?filter=7&timeout=30000&since=s14094047_178730_33991_755371_4320&access_token=$state_accessTOKEN" \
777 | # -H 'Host: matrix.org' \
778 | # -H 'User-Agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:43.0) Gecko/20100101 Firefox/43.0' \
779 | # -H 'Accept: application/json' \
780 | # -H 'Accept-Language: en-US,en;q=0.5' \
781 | # --compressed \
782 | # -H 'Referer: https://vector.im/develop/' \
783 | # -H 'Origin: https://vector.im' \
784 | # -H 'Connection: keep-alive'
785 | }
786 |
787 | GetPushRules() { ## dump the current PushRules to stdout as formatted JSON
788 | curl "$state_baseURL/r0/pushrules/?access_token=$state_accessTOKEN" | jq .
789 | }
790 |
791 | GetRoomState() { ## dump the current Roomstate to stdout as formatted JSON
792 | echo curl --silent -XGET "$state_baseURL/r0/rooms/{roomId}/state?access_token=$state_accessTOKEN"
793 | resp=`curl --silent -XGET "$state_baseURL/api/v1/initialSync?limit=1&access_token=$state_accessTOKEN"`
794 | echo "==== raw ===="
795 | echo -e "$resp"
796 | echo "==== json ===="
797 | jq . /dev/stdin <<<$resp
798 |
799 | GET /_matrix/client/r0/rooms/{roomId}/state
800 | GET /_matrix/client/r0/rooms/{roomId}/state
801 | }
802 |
803 |
804 | SampleGets() { ## some sample gets that don't need authentication
805 | local _userId="${1:-@matthew:matrix.org}";
806 | rawurlencode "$_userId"
807 | _userId_encoded="$URLstring"
808 |
809 | local _URL="http://${_userId##*:}"
810 |
811 | echo "Public Room List for $_URL"
812 | echo "More info is available for each room but limited to just the room name here"
813 | echo " Also we are limiting to the first 10 rooms incase it's run against a big server like matrix.org"
814 | wget -q -O /dev/stdout $_URL/_matrix/client/r0/publicRooms | jq '.[] | .[].name' 2>/dev/null | head -n 10;
815 | echo
816 |
817 | echo "User Profile for user $_userId at $_URL"
818 | wget -q -O /dev/stdout $_URL/_matrix/client/r0/profile/${_userId_encoded}/profile | jq '.';
819 | echo
820 |
821 | echo "Avatar URL for user $_userId at $_URL"
822 | wget -q -O /dev/stdout $_URL/_matrix/client/r0/profile/${_userId_encoded}/avatar_url | jq '.';
823 | echo
824 | }
825 |
826 | if ! $SOURCED; then
827 | $VERBOSE && dump_State;
828 | fi
829 |
830 | "$@"
831 |
832 | if ! $SOURCED; then
833 | store_State
834 | fi
835 |
--------------------------------------------------------------------------------