-
Notifications
You must be signed in to change notification settings - Fork 4
/
locallib.php
515 lines (440 loc) · 16.9 KB
/
locallib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<?php
// This file is part of Moodle - https://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <https://www.gnu.org/licenses/>.
/**
* Provides library functions used by plugin
*
* @package local_chatlogs
* @copyright 2012 Dan Poltawski <[email protected]>
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir.'/tablelib.php');
require_once($CFG->dirroot.'/local/chatlogs/lib.php');
/**
* Table listing jabber conversations
*
* @copyright 2012 Dan Poltawski <[email protected]>
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class local_chatlogs_converations_table extends table_sql {
/**
* Sets up the table_sql parameters
*
* @param string $uniqueid unique id of form
*/
public function __construct($uniqueid) {
parent::__construct($uniqueid);
$this->set_attribute('class', 'devchatslist generaltable generalbox');
if (!isset($this->sql)) {
$this->sql = new stdClass();
}
$this->sql->fields = 'conversationid, messagecount, timestart, timeend, (timestart - timeend) AS duration';
$this->sql->from = '{local_chatlogs_conversations}';
$this->sql->where = 'messagecount > 0';
$this->sql->params = [];
$this->define_columns(['conversationid', 'participants', 'messagecount', 'timestart', 'timeend', 'duration']);
$this->define_headers(['ID', 'Participants', 'Messages', 'Start', 'End', 'Duration']);
$this->no_sorting('participants');
$this->collapsible(false);
$this->sortable(true, 'timeend', SORT_DESC);
}
/**
* Generate the participants column by querying the chatlogs and dicsocvering
* participants for this column
*
* @param object $row row data
* @return string HTML for the particupants column
*/
public function col_participants($row) {
global $DB;
$userstring = $DB->sql_concat('u.firstname', "' '", 'u.lastname');
$sql = 'SELECT p.fromemail, COALESCE('.$userstring.', p.nickname)
FROM {local_chatlogs_messages} m
JOIN {local_chatlogs_participants} p
ON m.fromemail = p.fromemail
LEFT JOIN {user} u ON p.userid = u.id
WHERE m.conversationid = ?
GROUP BY p.fromemail, p.nickname, u.firstname, u.lastname';
$participants = $DB->get_records_sql_menu($sql, [$row->conversationid]);
$participants = implode(', ', $participants);
return $this->conversation_link($row->conversationid, $participants);
}
/**
* Generate conversationid cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_conversationid($row) {
return $this->conversation_link($row->conversationid, $row->conversationid);
}
/**
* Generate messagecount cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_messagecount($row) {
return $this->conversation_link($row->conversationid, $row->messagecount);
}
/**
* Generate duration cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_duration($row) {
return format_time($row->duration);
}
/**
* Generate timestart cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_timestart($row) {
return userdate($row->timestart);
}
/**
* Generate timeend cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_timeend($row) {
return userdate($row->timeend);
}
/**
* Generate a link to a specific conversation
*
* @param int $id converationid of converation
* @param string $text text contained within link
* @return string HTML of link
*/
private function conversation_link($id, $text) {
$url = new moodle_url('/local/chatlogs/index.php', ['conversationid' => $id]);
return html_writer::link($url, $text);
}
}
/**
* A jabber conversation
*
* @copyright 2012 Dan Poltawski <[email protected]>
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class local_chatlogs_conversation {
/** @var object From from the chatlogs_conversations table */
private $conversation = null;
/**
* Html link to previous conversation or empty string if none
* @var string
* */
private $previouslink = null;
/**
* Html link to next conversation or empty string if none
* @var string
* */
private $nextlink = null;
/**
* Filter to do url to link convresation
* @var local_chatlogs_filter
* */
private $urlfilter = null;
/**
* Creates a conversation object based on converationid
* @param int $conversationid id of conversation to creaet
*/
public function __construct($conversationid) {
global $DB;
$this->urlfilter = new local_chatlogs\urlfilter();
$this->conversation = $DB->get_record('local_chatlogs_conversations',
['conversationid' => $conversationid], '*', MUST_EXIST);
}
/**
* Get a link to the previous conversation
*
* @return string the html of previous converation
*/
private function get_previous_link() {
global $DB;
if ($this->previouslink !== null) {
return $this->previouslink;
}
$this->previouslink = '';
$sql = 'SELECT * FROM {local_chatlogs_conversations}
WHERE id != ? AND timeend < ? AND messagecount > 0
ORDER BY timeend DESC LIMIT 1';
$previous = $DB->get_record_sql($sql, [$this->conversation->id, $this->conversation->timeend]);
if ($previous) {
$url = new moodle_url('/local/chatlogs/index.php',
['conversationid' => $previous->conversationid]);
$this->previouslink = html_writer::link($url, '◄ '.$previous->messagecount.' messages',
['class' => 'previouslink']);
}
return $this->previouslink;
}
/**
* Get a link to the next conversation
*
* @return string the html of next converation
*/
private function get_next_link() {
global $DB;
if ($this->nextlink !== null) {
return $this->nextlink;
}
$this->nextlink = '';
$sql = 'SELECT * FROM {local_chatlogs_conversations}
WHERE id != ? AND timeend > ? AND messagecount > 0
ORDER BY timeend ASC LIMIT 1';
$next = $DB->get_record_sql($sql, [$this->conversation->id, $this->conversation->timeend]);
if ($next) {
$url = new moodle_url('/local/chatlogs/index.php', ['conversationid' => $next->conversationid]);
$this->nextlink = html_writer::link($url, $next->messagecount.' messages ►',
['class' => 'nextlink']);
}
return $this->nextlink;
}
/**
* Generates header html of conversation
*
* @return the header html of a conversation
*/
public function conversation_header() {
global $OUTPUT;
$starttime = userdate($this->conversation->timestart);
$duration = format_time($this->conversation->timeend - $this->conversation->timestart);
$header = new html_table();
$header->width = '100%';
$header->wrap = ['nowrap', '', 'nowrap'];
$header->size = ['', '100%', ''];
$header->data[] = [
$OUTPUT->heading($this->get_previous_link()),
$OUTPUT->heading("$starttime, for $duration"),
$OUTPUT->heading($this->get_next_link()),
];
return html_writer::table($header);
}
/**
* Generates footer html of conversation
*
* @return the footer html of a conversation
*/
public function conversation_footer() {
global $OUTPUT;
$footer = new html_table();
$footer->wrap = ['nowrap', '', 'nowrap'];
$footer->width = '100%';
$footer->size = ['', '100%', ''];
$footer->data[] = [
$OUTPUT->heading($this->get_previous_link()),
$OUTPUT->heading(html_writer::link(new moodle_url('/local/chatlogs/index.php'),
get_string('allconversations', 'local_chatlogs'))),
$OUTPUT->heading($this->get_next_link()),
];
return html_writer::table($footer);
}
/**
* Generates html of conversation
*
* @return the html representation of a conversation
*/
public function render() {
global $DB, $OUTPUT, $PAGE;
// Adds a handy left/right arrow shortcut.
$PAGE->requires->yui_module('moodle-local_chatlogs-keyboard', 'M.local_chatlogs.init_keyboard');
$sql = 'SELECT m.id AS messageid, m.fromemail, m.fromplace, m.timesent,
m.message, p.nickname, p.userid' . \core_user\fields::for_userpic()->get_sql('u')->selects .
' FROM {local_chatlogs_messages} m
LEFT JOIN {local_chatlogs_participants} p
ON m.fromemail = p.fromemail
LEFT JOIN {user} u
ON p.userid = u.id
WHERE m.conversationid = :conversationid
ORDER BY m.timesent';
$rs = $DB->get_recordset_sql($sql, ['conversationid' => $this->conversation->conversationid]);
echo $this->conversation_header();
$table = new html_table();
$table->attributes['class'] = 'devchat';
$table->wrap = ['nowrap', 'nowrap', ''];
foreach ($rs as $message) {
$time = userdate($message->timesent, "%I:%M:%S %P");
$namecell = new html_table_cell();
$namecell->attributes['title'] = $message->fromemail.'/'.$message->fromplace;
$namecell->attributes['class'] = 'userinfo usersays';
if (!empty($message->userid)) {
$namecell->text = fullname($message) . html_writer::empty_tag('br');
} else {
$namecell->text = $message->nickname . html_writer::empty_tag('br');
}
$namecell->text .= html_writer::link('#c'.$message->messageid, $time, ['class' => 'jabbertime']);
$messagecell = new html_table_cell();
$messagecell->attributes['class'] = 'talkmessage';
if (trim(substr($message->message, 0, 4)) == '/me') {
$namecell->attributes['class'] = 'userinfo useractions';
$messagecell->attributes['class'] = 'chataction';
$messagecell->text .= $message->nickname.' ';
$message->message = substr(trim($message->message), 4);
}
// This is a bit of a hack to make the format plain, but have clickable links..
$formatedmessage = format_text($message->message, FORMAT_PLAIN, ['para' => false]);
$this->urlfilter->convert_urls_into_links($formatedmessage);
$messagecell->text .= $formatedmessage;
$imagecell = new html_table_cell();
if (!empty($message->userid)) {
$imagecell->attributes['class'] = 'userimage';
$imagecell->text = $OUTPUT->user_picture($message);
}
$row = new html_table_row();
$row->id = 'c'.$message->messageid;
$row->cells = [$imagecell, $namecell, $messagecell];
$table->data[] = $row;
}
$rs->close();
echo html_writer::table($table);
echo $this->conversation_footer();
}
}
/**
* Table listing chat search results
*
* @copyright 2012 Dan Poltawski <[email protected]>
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class local_chatlogs_search_table extends table_sql {
/**
* @var string Search term used to search the logs.
*/
private $searchterm = null;
/**
* Sets up the table_sql parameters
*
* @param string $uniqueid unique id of form
* @param string $searchterm of search
*/
public function __construct($uniqueid, $searchterm) {
global $DB;
parent::__construct($uniqueid);
$this->searchterm = $searchterm;
$this->set_attribute('class', 'devchat');
if (!isset($this->sql)) {
$this->sql = new stdClass();
}
$this->sql->fields = 'm.id AS messageid, m.fromemail, m.fromplace, m.timesent,
m.message, m.conversationid, p.nickname,
p.userid ' . \core_user\fields::for_userpic()->get_sql('u')->selects;
$this->sql->from = '{local_chatlogs_messages} m
LEFT JOIN {local_chatlogs_participants} p
ON m.fromemail = p.fromemail
LEFT JOIN {user} u ON p.userid = u.id';
$this->sql->where = $DB->sql_like('m.message', ':search');
$this->sql->params = ['search' => '%'.$searchterm.'%'];
$this->define_columns(['timesent', 'userpic', 'userid', 'message']);
$this->define_headers(['Timesent', '', 'User', 'Message']);
$this->column_class('timesent', 'userinfo');
$this->column_class('userpic', 'userpic');
$this->column_class('userid', 'userinfo usersays');
$this->column_class('message', 'talkmessage');
$this->no_sorting('message');
$this->collapsible(false);
$this->sortable(true, 'timesent', SORT_DESC);
}
/**
* Generate timesent cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_timesent($row) {
$link = new moodle_url('/local/chatlogs/index.php');
$link->params( ['conversationid' => $row->conversationid]);
$link->set_anchor('c'.$row->messageid);
return html_writer::link($link, userdate($row->timesent), ['class' => 'jabbertime']);
}
/**
* Generate userid cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_userid($row) {
if (empty($row->userid)) {
return $row->nickname;
} else {
return fullname($row);
}
}
/**
* Generate userpic cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_userpic($row) {
global $OUTPUT;
if (!empty($row->userid)) {
return $OUTPUT->user_picture($row);
}
return '';
}
/**
* Generate message cell
*
* @param stdClass $row row data
* @return string HTML for the column
*/
public function col_message($row) {
$text = '';
if (trim(substr($row->message, 0, 4)) == '/me') {
// Convert /me.
$text .= $row->nickname.' ';
$row->message = substr(trim($row->message), 4);
}
$message = format_text($row->message, FORMAT_MOODLE, ['para' => false]);
$text .= highlight($this->searchterm, $message);
return $text;
}
/**
* Returns the search form for searching chat messages
*
* @param string $searchtext text searched for
* @return string HTML for searchform
*/
public static function form($searchtext = '') {
$o = '';
$url = new moodle_url('/local/chatlogs/index.php');
$o .= html_writer::start_tag('div', ['class' => 'searchform']);
$o .= html_writer::start_tag('form', ['method' => 'get', 'action' => $url->out()]);
$o .= html_writer::empty_tag('input', ['type' => 'text', 'name' => 'q',
'value' => $searchtext, 'maxlength' => 100, 'size' => 20]);
$o .= html_writer::empty_tag('input', ['type' => 'submit', 'value' => get_string('searchmessages', 'local_chatlogs')]);
$o .= html_writer::end_tag('form');
$o .= html_writer::end_tag('div');
return $o;
}
}
/**
* A require_capability() like function for this module.
*
* As we can't use capbilties alone this emulates the acceslib function to prevent having to do
* it in ever file.
*/
function local_chatlogs_require_capability() {
if (!local_chatlogs_can_access()) {
throw new moodle_exception('nopermissions', 'error', '', get_string('viewchatlogs', 'local_chatlogs'));
die;
}
}