index.php 55 KB
Newer Older
1 2 3 4
<?php
/**
 *
 * @package    mahara
5
 * @subpackage auth-webservice
6
 * @author     Catalyst IT Ltd
7 8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9 10 11 12 13 14
 *
 */

define('INTERNAL', 1);
define('ADMIN', 1);
require(dirname(dirname(dirname(__FILE__))) . '/init.php');
15
define('MENUITEM', 'configextensions/webservices');
16 17 18 19 20 21 22 23

$path = get_config('docroot') . 'lib/zend';
set_include_path($path . PATH_SEPARATOR . get_include_path());
require_once(get_config('docroot').'webservice/lib.php');
require_once(get_config('docroot') . 'api/xmlrpc/lib.php');
define('TITLE', get_string('webservices_title', 'auth.webservice'));
require_once('pieforms/pieform.php');

24 25
safe_require('auth', 'webservice');
$heading = get_string('webservices_title', 'auth.webservice');
26
$webservice_menu = PluginAuthWebservice::admin_menu_items();
27
$form = get_config_options_extended();
28 29
$serviceenabled = get_string('webservicesenabled', 'auth.webservice');
$servicenotenabled = get_string('webservicesnotenabled', 'auth.webservice');
30

31 32
$inlinejs = <<<JS
    jQuery(function ($) {
33 34
        var webservicesenabled = '$serviceenabled';
        var webservicesnotenabled = '$servicenotenabled';
35
        function save_protos_switch(name) {
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
            // Check if we have master switch and at least one protocol active
            var master = $('#activate_webservices').find('input:checkbox');
            var target = $('#activate_webservices').siblings('.form-group').find('input:checkbox');

            if ($(master).filter(':checked').length) {
                // master switch is on
                if (target.filter(':checked').length === 0) {
                    $('#needprotocols').removeClass('text-success').addClass('text-danger').text(webservicesnotenabled);
                }
                else {
                    $('#needprotocols').removeClass('text-danger').addClass('text-success').text(webservicesenabled);
                }
            }
            else {
                $('#needprotocols').removeClass('text-danger').removeClass('text-success').text('');
            }

            // Save new state
54 55 56 57 58 59
            if (!$('#ajax_' + name).length) {
                $('#activate_webservice_protos_' + name).append('<input id="ajax_' + name + '" type="hidden" name="ajax" value="1">');
            }
            $.post('index.php', $('#activate_webservice_protos_' + name).serialize());
        }

60 61 62 63 64 65
        if (!$('#needprotocols').length) {
            $('#activate_webservices_enabled_container').append('<span id="needprotocols" class="form-message-inline pll"></span>');
        }

        $('#activate_webservices_enabled').on('change', function() {
            var target = $(this).closest('form').siblings('.form-group').find('input:checkbox');
66 67
            if ($(this).is(':checked')) {
                // alert user to switch protocols on if none are active
68 69 70 71 72
                if (target.filter(':checked').length === 0) {
                    $('#needprotocols').removeClass('text-success').addClass('text-danger').text(webservicesnotenabled);
                }
                else {
                    $('#needprotocols').removeClass('text-danger').addClass('text-success').text(webservicesenabled);
73 74 75
                }
            }
            else {
76 77
                // turn all protocols off
                target.prop('checked', false);
78
                $('#activate_webservices').append('<input type="hidden" name="ajax" value="1">');
79
                $('#activate_webservices_pseudofieldset .form-message-inline').text('');
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
            }
            // save master switch form
            $.post('index.php', $('#activate_webservices').serialize());
        });
        // saving the form when switching the protocols
        $('#activate_webservice_protos_soap_enabled').change(function() {
            save_protos_switch('soap');
        });
        $('#activate_webservice_protos_xmlrpc_enabled').change(function() {
            save_protos_switch('xmlrpc');
        });
        $('#activate_webservice_protos_rest_enabled').change(function() {
            save_protos_switch('rest');
        });
        $('#activate_webservice_protos_oauth_enabled').change(function() {
            save_protos_switch('oauth');
        });
    });
JS;

100 101 102
$smarty = smarty();
setpageicon($smarty, 'icon-puzzle-piece');

103
$smarty->assign('form', $form);
104
$smarty->assign('opened', param_alphanumext('open', ''));
105
$smarty->assign('SUBPAGENAV', $webservice_menu);
106
$smarty->assign('PAGEHEADING', $heading);
107
$smarty->assign('INLINEJAVASCRIPT', $inlinejs);
108 109
$smarty->assign('pagedescription', get_string('webservicesconfigdesc', 'auth.webservice'));
$smarty->display('auth:webservice:configform.tpl');
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

/* pieforms callback for activate_webservices for
 */
function activate_webservices_submit(Pieform $form, $values) {

    $enabled = $values['enabled'] ? 0 : 1;
    set_config('webservice_enabled', $enabled);

    // reload/upgrade the web services configuration
    if ($enabled) {
        // ensure that we have a webservice auth_instance
        $authinstance = get_record('auth_instance', 'institution', 'mahara', 'authname', 'webservice');
        if (empty($authinstance)) {
            $authinstance = (object)array(
                   'instancename' => 'webservice',
                    'priority'     => 2,
                    'institution'  => 'mahara',
                    'authname'     => 'webservice',
            );
            insert_record('auth_instance', $authinstance);
        }
        external_reload_webservices();
    }
133 134 135 136 137 138 139
    if (!empty($_POST['ajax'])) {
        $protos = array('soap','xmlrpc','rest','oauth');
        foreach ($protos as $proto) {
            set_config('webservice_'.$proto.'_enabled', 0);
        }
        exit;
    }
140
    redirect('/webservice/admin/index.php?open=activate_webservices');
141 142 143 144 145 146
}

function activate_webservice_proto_submit(Pieform $form, $values) {
    $enabled = $values['enabled'] ? 0 : 1;
    $proto = $values['protocol'];
    set_config('webservice_'.$proto.'_enabled', $enabled);
147 148 149
    if (!empty($_POST['ajax'])) {
        exit;
    }
150
    redirect('/webservice/admin/index.php');
151 152 153 154 155 156 157 158 159 160 161 162
}

function webservices_function_groups_submit(Pieform $form, $values) {
    global $SESSION;

    if ($values['action'] == 'add') {
        $service = preg_replace('/[^a-zA-Z0-9_ ]+/', '', $values['service']);
        $service = trim($service);
        if (empty($service) || record_exists('external_services', 'name', $service)) {
            $SESSION->add_error_msg(get_string('invalidinput', 'auth.webservice'));
        }
        else {
163
            $service = array('name' => $service, 'restrictedusers' => 0, 'enabled' => 0, 'tokenusers' => 0, 'component' => 'webservice', 'ctime' => db_format_timestamp(time()));
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
            insert_record('external_services', $service);
            $SESSION->add_ok_msg(get_string('configsaved', 'auth.webservice'));
        }
    }
    else {
        $service = get_record('external_services', 'id', $values['service']);
        if (!empty($service)) {
            if ($values['action'] == 'edit') {
                redirect('/webservice/admin/serviceconfig.php?service=' . $values['service']);
            }
            else if ($values['action'] == 'delete') {
                // remove everything associated with a service
                $params = array($values['service']);
                delete_records_select('external_tokens', "externalserviceid  = ?", $params);
                delete_records_select('external_services_users', "externalserviceid  = ?", $params);
                delete_records_select('external_services_functions', "externalserviceid  = ?", $params);
                delete_records('external_services', 'id', $values['service']);
                $SESSION->add_ok_msg(get_string('configsaved', 'auth.webservice'));
            }
        }
    }

    // default back to where we came from
187
    redirect('/webservice/admin/index.php?open=webservices_function_groups');
188 189 190 191 192 193
}

function webservices_token_submit(Pieform $form, $values) {
    global $SESSION, $USER;

    if ($values['action'] == 'generate') {
194
        if (!empty($values['userid'][0])) {
195
            $dbuser = get_record('usr', 'id', $values['userid'][0]);
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
            if (!empty($dbuser)) {
                $services = get_records_array('external_services', 'restrictedusers', 0);
                if (empty($services)) {
                    $SESSION->add_error_msg(get_string('noservices', 'auth.webservice'));
                }
                else {
                    // just pass the first one for the moment
                    $service = array_shift($services);
                    $token = webservice_generate_token(EXTERNAL_TOKEN_PERMANENT, $service, $dbuser->id);
                    $dbtoken = get_record('external_tokens', 'token', $token);
                    redirect('/webservice/admin/tokenconfig.php?token=' . $dbtoken->id);
                }
            }
            else {
                $SESSION->add_error_msg(get_string('invaliduserselected', 'auth.webservice'));
            }
        }
        else {
            $SESSION->add_error_msg(get_string('nouser', 'auth.webservice'));
        }

    }
    else {
        $token = get_record('external_tokens', 'id', $values['token']);
        if (!empty($token)) {
            if ($values['action'] == 'edit') {
                redirect('/webservice/admin/tokenconfig.php?token=' . $values['token']);
            }
            else if ($values['action'] == 'delete') {
                // remove everything associated with a service
                $params = array($values['token']);
                delete_records_select('external_tokens', "id = ?", $params);
                $SESSION->add_ok_msg(get_string('configsaved', 'auth.webservice'));
            }
        }
    }

    // default back to where we came from
234
    redirect('/webservice/admin/index.php?open=webservices_token');
235 236 237 238 239 240
}

function webservices_user_submit(Pieform $form, $values) {
    global $SESSION, $USER;

    if ($values['action'] == 'add') {
241
        if (!empty($values['userid'][0])) {
242
            $dbuser = get_record('usr', 'id', $values['userid'][0]);
243 244 245 246 247 248 249 250 251 252 253 254 255 256
            if ($auth_instance = webservice_validate_user($dbuser)) {
                // make sure that this account is not already in use
                $existing = get_record('external_services_users', 'userid', $dbuser->id);
                if (empty($existing)) {
                    $services = get_records_array('external_services', 'restrictedusers', 1);
                    if (empty($services)) {
                      $SESSION->add_error_msg(get_string('noservices', 'auth.webservice'));
                    }
                    else {
                        // just pass the first one for the moment
                        $service = array_shift($services);
                        $dbserviceuser = (object) array('externalserviceid' => $service->id,
                                        'userid' => $dbuser->id,
                                        'institution' => $auth_instance->institution,
257
                                        'ctime' => db_format_timestamp(time()),
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
                                        'publickeyexpires' => time(),
                                        'wssigenc' => 0,
                                        'publickey' => '');
                        $dbserviceuser->id = insert_record('external_services_users', $dbserviceuser, 'id', true);
                        redirect('/webservice/admin/userconfig.php?suid=' . $dbserviceuser->id);
                    }
                }
                else {
                    $SESSION->add_error_msg(get_string('duplicateuser', 'auth.webservice'));
                }
            }
            else {
                $SESSION->add_error_msg(get_string('invaliduserselected', 'auth.webservice'));
            }
        }
        else {
            $SESSION->add_error_msg(get_string('nouser', 'auth.webservice'));
        }
    }
    else {
        $dbserviceuser = get_record('external_services_users', 'id', $values['suid']);
        if (!empty($dbserviceuser)) {
            if ($values['action'] == 'edit') {
                redirect('/webservice/admin/userconfig.php?suid=' . $values['suid']);
            }
            else if ($values['action'] == 'delete') {
                // remove everything associated with a service
                $params = array($values['suid']);
                delete_records_select('external_services_users', "id = ?", $params);
                $SESSION->add_ok_msg(get_string('configsaved', 'auth.webservice'));
            }
        }
    }

    // default back to where we came from
293
    redirect('/webservice/admin/index.php?open=webservices_user');
294 295 296 297 298 299 300 301 302 303 304
}

/**
 * Form layout for webservices master switch fieldset
 *
 * @return pieforms $element array
 */
function webservices_master_switch_form() {
    // enable/disable webservices completely
    $enabled = (get_config('webservice_enabled') || 0);
    $elements =
305 306 307 308 309 310 311 312 313
        array(
            'webservicesmasterswitchform' =>
                array(
                    'type' => 'html',
                    'value' =>
                        pieform(
                            array(
                                'name' => 'activate_webservices',
                                'elementclasses' => false,
314
                                'class'           => 'form-switch',
315 316 317
                                'successcallback' => 'activate_webservices_submit',
                                'renderer' => 'div',
                                'jsform' => false,
318
                                'checkdirtychange' => false,
319 320 321 322 323
                                'elements' => array(
                                    'plugintype' => array('type' => 'hidden', 'value' => 'auth'),
                                    'type' => array('type' => 'hidden', 'value' => 'webservice'),
                                    'pluginname' => array('type' => 'hidden', 'value' => 'webservice'),
                                    'enabled' => array('type' => 'switchbox',
Naomi Guyer's avatar
Naomi Guyer committed
324
                                        'class' => 'last',
325
                                        'value' => $enabled,
Naomi Guyer's avatar
Naomi Guyer committed
326
                                        'labelhtml' => '<span class="pseudolabel">'. get_string('control_webservices', 'auth.webservice') .'</span>',
327
                                    ),
328
                                ),
329 330 331 332
                            )
                        ),
                ),
        );
333 334 335 336 337 338 339 340 341 342 343 344

    return $elements;
}

/**
 * Form layout for webservices protocol switch fieldset
 *
 * @return pieforms $element array
 */
function webservices_protocol_switch_form() {
    // enable/disable separate protocols of SOAP/XML-RPC/REST
    $elements = array();
345 346 347 348 349 350
    $elements['label'] = array(
        'title' => ' ',
        'type' => 'html',
        'class' => 'fake-form',
        'value' => '<h4 class="mb0 title">' . get_string('protocol', 'auth.webservice') . '</h4>'
    );
351 352 353 354 355 356

    foreach (array('soap', 'xmlrpc', 'rest', 'oauth') as $proto) {
        $enabled = (get_config('webservice_' . $proto . '_enabled') || 0);
        $elements[$proto] =  array(
            'title' => ' ',
            'type' => 'html',
Naomi Guyer's avatar
Naomi Guyer committed
357
            'class'            => 'fake-form',
358 359 360 361
            'value' =>
        pieform(array(
            'name'            => 'activate_webservice_protos_' . $proto,
            'elementclasses'  => false,
362
            'class'           => 'form-switch',
363
            'renderer'        => 'div',
364 365
            'successcallback' => 'activate_webservice_proto_submit',
            'jsform'          => false,
366
            'checkdirtychange' => false,
367
            'elements' => array(
368

369 370 371 372
                'plugintype' => array('type' => 'hidden', 'value' => 'auth'),
                'type'       => array('type' => 'hidden', 'value' => 'webservice'),
                'pluginname' => array('type' => 'hidden', 'value' => 'webservice'),
                'protocol'   => array('type' => 'hidden', 'value' => $proto),
373 374
                'enabled'    => array('type' => 'switchbox',
                                      'value' => $enabled,
Naomi Guyer's avatar
Naomi Guyer committed
375
                                      'labelhtml' => '<span class="pseudolabel">' .get_string($proto, 'auth.webservice') . ': </span>',
376
                                      ),
377 378 379 380 381 382 383 384 385 386 387 388 389
            ),
        )));
    }

    return $elements;
}

/**
 * Service Function Groups edit form
 *
 * @return html
 */
function service_fg_edit_form() {
390
    global $THEME;
391

392 393
    $editicon = 'icon icon-pencil prm';
    $deleteicon = 'icon icon-trash prm text-danger';
394

395 396 397 398 399 400 401 402
    $form = array(
        'name'            => 'webservices_function_groups',
        'elementclasses'  => false,
        'successcallback' => 'webservices_function_groups_submit',
        'renderer'   => 'multicolumntable',
        'elements'   => array(
                        'servicegroup' => array(
                            'title' => ' ',
403
                            'datatable' => true,
404 405 406 407 408
                            'type'  => 'html',
                            'value' => get_string('service', 'auth.webservice'),
                        ),
                        'component' => array(
                            'title' => ' ',
409
                            'datatable' => true,
410 411 412 413 414
                            'type'  => 'html',
                            'value' => get_string('component', 'auth.webservice'),
                        ),
                        'enabled' => array(
                            'title' => ' ',
415
                            'datatable' => true,
416
                            'type'  => 'html',
417
                            'value' => get_string('enabled'),
418 419 420
                        ),
                        'restricted' => array(
                            'title' => ' ',
421
                            'datatable' => true,
422 423 424 425 426
                            'type'  => 'html',
                            'value' => get_string('restrictedusers', 'auth.webservice'),
                        ),
                        'tokenusers' => array(
                            'title' => ' ',
427
                            'datatable' => true,
428 429 430 431 432
                            'type'  => 'html',
                            'value' => get_string('fortokenusers', 'auth.webservice'),
                        ),
                        'functions' => array(
                            'title' => ' ',
433
                            'datatable' => true,
434 435 436
                            'type'  => 'html',
                            'value' => get_string('functions', 'auth.webservice'),
                        ),
437 438 439 440 441 442
                        'actions' => array(
                            'title' => ' ',
                            'datatable' => true,
                            'type'  => 'html',
                            'value' => '',
                        ),
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
                    ),
        );

    $dbservices = get_records_array('external_services', null, null, 'name');
    if ($dbservices) {
        foreach ($dbservices as $service) {
            $form['elements']['id'. $service->id . '_service'] = array(
                'value'        =>  $service->name,
                'type'         => 'html',
                'key'          => $service->name,
            );
            $form['elements']['id'. $service->id . '_component'] = array(
                'value'        =>  $service->component,
                'type'         => 'html',
                'key'          => $service->name,
            );
            $form['elements']['id'. $service->id . '_enabled'] = array(
460 461 462
                'value'        => (($service->enabled == 1) ? display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
463 464 465
                'key'          => $service->name,
            );
            $form['elements']['id'. $service->id . '_restricted'] = array(
466 467 468
                'value' => (($service->restrictedusers == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
469 470 471
                'key'          => $service->name,
            );
            $form['elements']['id'. $service->id . '_tokenusers'] = array(
472 473 474
                'value' => (($service->tokenusers == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
                'key'          => $service->name,
            );
            $functions = get_records_array('external_services_functions', 'externalserviceid', $service->id);
            $function_list = array();
            if ($functions) {
                foreach ($functions as $function) {
                    $dbfunction = get_record('external_functions', 'name', $function->functionname);
                    $function_list[]= '<a href="' . get_config('wwwroot') . 'webservice/wsdoc.php?id=' . $dbfunction->id . '">' . $function->functionname . '</a>';
                }
            }
            $form['elements']['id'. $service->id . '_functions'] = array(
                'value'        =>  implode(', ', $function_list),
                'type'         => 'html',
                'key'          => $service->name,
            );

            // edit and delete buttons
            $form['elements']['id'. $service->id . '_actions'] = array(
493
                'value'        => pieform(array(
494 495
                                    'name'            => 'webservices_function_groups_edit_' . $service->id,
                                    'renderer'        => 'div',
Naomi Guyer's avatar
Naomi Guyer committed
496
                                    'class'  => 'form-as-button pull-left',
497 498 499 500 501 502 503
                                    'successcallback' => 'webservices_function_groups_submit',
                                    'jsform'          => false,
                                    'action'          => get_config('wwwroot') . 'webservice/admin/index.php',
                                    'elements' => array(
                                        'service'    => array('type' => 'hidden', 'value' => $service->id),
                                        'action'     => array('type' => 'hidden', 'value' => 'edit'),
                                        'submit'     => array(
504 505 506
                                                'type'  => 'button',
                                                'class' => 'btn btn-default btn-sm',
                                                'usebuttontag' => true,
Naomi Guyer's avatar
Naomi Guyer committed
507
                                                'value'   => '<span class="'.$editicon.'"></span>' . get_string('edit', 'mahara'),
508
                                                'elementtitle' => get_string('edit'),
509 510 511 512 513 514 515
                                            ),
                                    ),
                                ))
                                .
                                pieform(array(
                                    'name'            => 'webservices_function_groups_delete_' . $service->id,
                                    'renderer'        => 'div',
Naomi Guyer's avatar
Naomi Guyer committed
516
                                    'class'  => 'form-as-button pull-left',
517 518 519 520 521 522 523
                                    'successcallback' => 'webservices_function_groups_submit',
                                    'jsform'          => false,
                                    'action'          => get_config('wwwroot') . 'webservice/admin/index.php',
                                    'elements' => array(
                                        'service'    => array('type' => 'hidden', 'value' => $service->id),
                                        'action'     => array('type' => 'hidden', 'value' => 'delete'),
                                        'submit'     => array(
524 525 526
                                                'type'  => 'button',
                                                'usebuttontag' => true,
                                                'class' => 'btn btn-default btn-sm',
Naomi Guyer's avatar
Naomi Guyer committed
527
                                                'value'   => '<span class="'.$deleteicon.'"></span>' . get_string('delete', 'mahara'),
528
                                                'elementtitle' => get_string('delete'),
529 530
                                            ),
                                    ),
531
                                ))
532 533 534
                                ,
                'type'         => 'html',
                'key'          => $service->name,
535
                'class'        => 'webserviceconfigcontrols text-right btn-top-right btn-group btn-group-top',
536 537 538
            );
        }
    }
539

540 541
    $pieform = new pieform($form);
    return $pieform->build(false) . '<div class="function_add">' .
Naomi Guyer's avatar
Naomi Guyer committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
        pieform(array(
            'name'            => 'webservices_function_groups_add',
            'renderer'        => 'div',
            'successcallback' => 'webservices_function_groups_submit',
            'class'           => 'form-inline',
            'jsform'          => false,
            'action'          => get_config('wwwroot') . 'webservice/admin/index.php',
            'elements' => array(
                'service'    => array(
                    'type' => 'text',
                    'class' => 'last'
                ),
                'action'     => array('type' => 'hidden', 'value' => 'add'),
                'submit'     => array(
                        'type'  => 'submit',
                        'class' => 'submit btn btn-success last',
                        'value' => get_string('add')
                    ),
            ),
        )) .
        '</div>';
563 564 565 566 567 568 569 570 571 572
}

/**
 * Service Tokens Groups edit form
 *
 * @return html
 */
function service_tokens_edit_form() {
    global $THEME, $USER;

573 574
    $editicon = 'icon icon-pencil prm';
    $deleteicon = 'icon icon-trash prm  text-danger';
575

576 577 578 579
    $form = array(
        'name'            => 'webservices_tokens',
        'elementclasses'  => false,
        'successcallback' => 'webservices_tokens_submit',
Naomi Guyer's avatar
Naomi Guyer committed
580
        'renderer'   => 'div',
581 582 583
        'elements'   => array(
                        'token' => array(
                            'title' => ' ',
584
                            'datatable'  => true,
585 586 587 588 589
                            'type'  => 'html',
                            'value' => get_string('token', 'auth.webservice'),
                        ),
                        'institution' => array(
                            'title' => ' ',
590
                            'datatable'  => true,
591 592 593 594 595
                            'type'  => 'html',
                            'value' => get_string('institution'),
                        ),
                        'username' => array(
                            'title' => ' ',
596
                            'datatable'  => true,
597 598 599 600 601
                            'type'  => 'html',
                            'value' => get_string('username', 'auth.webservice'),
                        ),
                        'servicename' => array(
                            'title' => ' ',
602
                            'datatable'  => true,
603 604 605 606 607
                            'type'  => 'html',
                            'value' => get_string('servicename', 'auth.webservice'),
                        ),
                        'enabled' => array(
                            'title' => ' ',
608
                            'datatable'  => true,
609
                            'type'  => 'html',
610
                            'value' => get_string('enabled'),
611 612 613
                        ),
                        'wssigenc' => array(
                            'title' => ' ',
614
                            'datatable'  => true,
615 616 617 618 619
                            'type'  => 'html',
                            'value' => get_string('titlewssigenc', 'auth.webservice'),
                        ),
                        'functions' => array(
                            'title' => ' ',
620
                            'datatable'  => true,
621 622 623
                            'type'  => 'html',
                            'value' => get_string('functions', 'auth.webservice'),
                        ),
624 625 626 627 628 629
                        'actions' => array(
                            'title' => ' ',
                            'datatable'  => true,
                            'type'  => 'html',
                            'value' => '',
                        ),
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
                    ),
        );

    $dbtokens = get_records_sql_array('SELECT et.id as tokenid, et.wssigenc AS wssigenc, et.externalserviceid as externalserviceid, et.institution as institution, u.id as userid, u.username as username, et.token as token, es.name as name, es.enabled as enabled FROM {external_tokens} AS et LEFT JOIN {usr} AS u ON et.userid = u.id LEFT JOIN {external_services} AS es ON et.externalserviceid = es.id WHERE et.tokentype = ? ORDER BY u.username', array(EXTERNAL_TOKEN_PERMANENT));
    if (!empty($dbtokens)) {
        foreach ($dbtokens as $token) {
            $form['elements']['id'. $token->tokenid . '_token'] = array(
                'value'        =>  $token->token,
                'type'         => 'html',
                'key'          => $token->token,
            );
            $dbinstitution = get_record('institution', 'name', $token->institution);
            $form['elements']['id'. $token->tokenid . '_institution'] = array(
                'value'        =>  $dbinstitution->displayname,
                'type'         => 'html',
                'key'          => $token->token,
            );
            if ($USER->is_admin_for_user($token->userid)) {
                $user_url = get_config('wwwroot') . 'admin/users/edit.php?id=' . $token->userid;
            }
            else {
                $user_url = get_config('wwwroot') . 'user/view.php?id=' . $token->userid;
            }
            $form['elements']['id'. $token->tokenid . '_username'] = array(
                'value'        =>  '<a href="' . $user_url . '">' . $token->username . '</a>',
                'type'         => 'html',
                'key'          => $token->token,
            );
            $form['elements']['id'. $token->tokenid . '_servicename'] = array(
                'value'        =>  $token->name,
                'type'         => 'html',
                'key'          => $token->token,
            );
            $form['elements']['id'. $token->tokenid . '_enabled'] = array(
664 665 666
                'value' => (($token->enabled == 1) ? display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
667 668 669
                'key'          => $token->token,
            );
            $form['elements']['id'. $token->tokenid . '_wssigenc'] = array(
670 671 672
                'value' => (($token->wssigenc == 1) ? display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
                'key'          => $token->token,
            );

            $functions = get_records_array('external_services_functions', 'externalserviceid', $token->externalserviceid);
            $function_list = array();
            if ($functions) {
                foreach ($functions as $function) {
                    $dbfunction = get_record('external_functions', 'name', $function->functionname);
                    $function_list[]= '<a href="' . get_config('wwwroot') . 'webservice/wsdoc.php?id=' . $dbfunction->id . '">' . $function->functionname . '</a>';
                }
            }
            $form['elements']['id'. $token->tokenid . '_functions'] = array(
                'value'        =>  implode(', ', $function_list),
                'type'         => 'html',
                'key'          => $token->token,
            );

            // edit and delete buttons
            $form['elements']['id'. $token->tokenid . '_actions'] = array(
Naomi Guyer's avatar
Naomi Guyer committed
692
                'value'        => '<span class="actions text-inline">' .
693 694 695 696 697
                                pieform(array(
                                    'name'            => 'webservices_token_edit_' . $token->tokenid,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_token_submit',
698
                                    'class'           => 'form-as-button',
699
                                    'jsform'          => false,
700 701 702 703
                                    'elements' => array(
                                        'token'      => array('type' => 'hidden', 'value' => $token->tokenid),
                                        'action'     => array('type' => 'hidden', 'value' => 'edit'),
                                        'submit'     => array(
704 705 706 707
                                                'type'  => 'button',
                                                'usebuttontag' => true,
                                                'class' => 'btn btn-default btn-sm',
                                                'value'   => '<span class="'.$editicon.'"></span>' . get_string('editspecific', 'mahara', $token->tokenid),
708
                                                'elementtitle' => get_string('edit'),
709 710 711 712 713 714 715 716 717
                                            ),
                                    ),
                                ))
                                .
                                pieform(array(
                                    'name'            => 'webservices_token_delete_' . $token->tokenid,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_token_submit',
718
                                    'class'           => 'form-as-button',
719
                                    'jsform'          => false,
720 721 722 723
                                    'elements' => array(
                                        'token'      => array('type' => 'hidden', 'value' => $token->tokenid),
                                        'action'     => array('type' => 'hidden', 'value' => 'delete'),
                                        'submit'     => array(
724 725 726 727
                                                'type'  => 'button',
                                                'usebuttontag' => true,
                                                'class' => 'btn btn-default btn-sm',
                                                'value'   => '<span class="'.$deleteicon.'"></span>' . get_string('deletespecific', 'mahara', $token->tokenid),
728
                                                'elementtitle' => get_string('delete'),
729 730 731 732 733 734
                                            ),
                                    ),
                                )) . '</span>'
                                ,
                'type'         => 'html',
                'key'          => $token->token,
735
                'class'        => 'webserviceconfigcontrols text-right btn-top-right btn-group btn-group-top',
736 737 738
            );
        }
    }
739 740 741 742
    else {
        // no results so hide headings
        $form['elements'] = array();
    }
743 744 745 746 747 748 749 750 751 752 753

    $username = '';
    if ($user  = param_integer('user', 0)) {
        $dbuser = get_record('usr', 'id', $user);
        if (!empty($dbuser)) {
            $username = $dbuser->username;
        }
    }
    else {
        $username = param_alphanum('username', '');
    }
754 755
    $pieform = new pieform($form);
    return $pieform->build(false) . '<div class="function_add">' .
756 757
                            pieform(array(
                                'name'            => 'webservices_token_generate',
Naomi Guyer's avatar
Naomi Guyer committed
758
                                'renderer'        => 'div',
759 760 761 762
                                'successcallback' => 'webservices_token_submit',
                                'jsform'          => false,
                                'action'          => get_config('wwwroot') . 'webservice/admin/index.php',
                                'elements' => array(
763 764 765 766
                                    'userid' => array(
                                        'type' => 'autocomplete',
                                        'title' => get_string('username') . ': ',
                                        'ajaxurl' => get_config('wwwroot') . 'webservice/admin/users.json.php',
767
                                        'multiple' => true,
768 769
                                        'allowclear' => true,
                                        'ajaxextraparams' => array(),
770 771 772 773
                                        'extraparams' => array(
                                            'maximumSelectionSize' => 1
                                        ),
                                        'width' => '280px',
774
                                    ),
775 776 777
                                    'action'     => array('type' => 'hidden', 'value' => 'generate'),
                                    'submit'     => array(
                                            'type'  => 'submit',
Naomi Guyer's avatar
Naomi Guyer committed
778
                                            'class' => 'submit btn btn-primary last',
779 780 781 782
                                            'value' => get_string('generate', 'auth.webservice')
                                        ),
                                ),
                            )).
783
         '</div>';
784 785 786 787 788 789 790 791 792 793 794

}

/**
 * Service Users edit form
 *
 * @return html
 */
function service_users_edit_form() {
    global $THEME, $USER;

795 796
    $editicon = 'icon icon-pencil prm';
    $deleteicon = 'icon icon-trash prm text-danger';
797

798 799 800 801 802 803 804 805
    $form = array(
        'name'            => 'webservices_users',
        'elementclasses'  => false,
        'successcallback' => 'webservices_users_submit',
        'renderer'   => 'multicolumntable',
        'elements'   => array(
                        'username' => array(
                            'title' => ' ',
806
                            'datatable'  => true,
807 808 809 810 811
                            'type'  => 'html',
                            'value' => get_string('username', 'auth.webservice'),
                        ),
                        'institution' => array(
                            'title' => ' ',
812
                            'datatable'  => true,
813 814 815 816 817
                            'type'  => 'html',
                            'value' => get_string('institution'),
                        ),
                        'servicename' => array(
                            'title' => ' ',
818
                            'datatable'  => true,
819 820 821 822 823
                            'type'  => 'html',
                            'value' => get_string('servicename', 'auth.webservice'),
                        ),
                        'enabled' => array(
                            'title' => ' ',
824
                            'datatable'  => true,
825
                            'type'  => 'html',
826
                            'value' => get_string('enabled'),
827 828 829
                        ),
                        'wssigenc' => array(
                            'title' => ' ',
830
                            'datatable'  => true,
831 832 833 834 835
                            'type'  => 'html',
                            'value' => get_string('titlewssigenc', 'auth.webservice'),
                        ),
                        'functions' => array(
                            'title' => ' ',
836
                            'datatable'  => true,
837 838 839
                            'type'  => 'html',
                            'value' => get_string('functions', 'auth.webservice'),
                        ),
840 841 842 843 844 845
                        'actions' => array(
                            'title' => ' ',
                            'datatable'  => true,
                            'type'  => 'html',
                            'value' => '',
                        ),
846 847 848
                    ),
        );

849
    $dbusers = get_records_sql_array('SELECT eu.id as id, eu.userid as userid, eu.wssigenc AS wssigenc, eu.externalserviceid as externalserviceid, eu.institution as institution, u.username as username, es.name as name, es.enabled as enabled FROM {external_services_users} AS eu LEFT JOIN {usr} AS u ON eu.userid = u.id LEFT JOIN {external_services} AS es ON eu.externalserviceid = es.id ORDER BY eu.id', array());
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
    if (!empty($dbusers)) {
        foreach ($dbusers as $user) {
            $dbinstitution = get_record('institution', 'name', $user->institution);
            if ($USER->is_admin_for_user($user->id)) {
                $user_url = get_config('wwwroot') . 'admin/users/edit.php?id=' . $user->userid;
            }
            else {
                $user_url = get_config('wwwroot') . 'user/view.php?id=' . $user->userid;
            }
            $form['elements']['id'. $user->id . '_username'] = array(
                'value'        =>  '<a href="' . $user_url . '">' . $user->username . '</a>',
                'type'         => 'html',
                'key'          => $user->id,
            );
            $form['elements']['id'. $user->id . '_institution'] = array(
                'value'        =>  $dbinstitution->displayname,
                'type'         => 'html',
                'key'          => $user->id,
            );
            $form['elements']['id'. $user->id . '_servicename'] = array(
                'value'        =>  $user->name,
                'type'         => 'html',
                'key'          => $user->id,
            );
            $form['elements']['id'. $user->id . '_enabled'] = array(
875 876 877
                'value' => (($user->enabled == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
878 879 880
                'key'          => $user->id,
            );
            $form['elements']['id'. $user->id . '_wssigenc'] = array(
881 882 883
                'value' => (($user->wssigenc == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
                'key'          => $user->id,
            );

            $functions = get_records_array('external_services_functions', 'externalserviceid', $user->externalserviceid);
            $function_list = array();
            if ($functions) {
                foreach ($functions as $function) {
                    $dbfunction = get_record('external_functions', 'name', $function->functionname);
                    $function_list[]= '<a href="' . get_config('wwwroot') . 'webservice/wsdoc.php?id=' . $dbfunction->id . '">' . $function->functionname . '</a>';
                }
            }
            $form['elements']['id'. $user->id . '_functions'] = array(
                'value'        =>  implode(', ', $function_list),
                'type'         => 'html',
                'key'          => $user->id,
            );

            // edit and delete buttons
            $form['elements']['id'. $user->id . '_actions'] = array(
Naomi Guyer's avatar
Naomi Guyer committed
903
                'value'        => '<span class="actions text-inline">' .
904 905 906 907 908
                                pieform(array(
                                    'name'            => 'webservices_user_edit_' . $user->id,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_user_submit',
909
                                    'class'           => 'form-as-button',
910
                                    'jsform'          => false,
911 912 913 914
                                    'elements' => array(
                                        'suid'       => array('type' => 'hidden', 'value' => $user->id),
                                        'action'     => array('type' => 'hidden', 'value' => 'edit'),
                                        'submit'     => array(
915 916 917 918
                                                'type'  => 'button',
                                                'usebuttontag' => true,
                                                'class' => 'btn btn-default btn-sm',
                                                'value'   => get_string('editspecific', 'mahara', $user->username),
919
                                                'elementtitle' => get_string('edit'),
920 921 922 923 924 925 926 927 928
                                            ),
                                    ),
                                ))
                                .
                                pieform(array(
                                    'name'            => 'webservices_user_delete_' . $user->id,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_user_submit',
929
                                    'class'           => 'form-as-button',
930
                                    'jsform'          => false,
931 932 933 934
                                    'elements' => array(
                                        'suid'       => array('type' => 'hidden', 'value' => $user->id),
                                        'action'     => array('type' => 'hidden', 'value' => 'delete'),
                                        'submit'     => array(
935 936 937 938
                                                'type'  => 'button',
                                                'usebuttontag' => true,
                                                'class' => 'btn btn-default btn-sm',
                                                'value'   => '<span class="'.$deleteicon.'"></span>' . get_string('deletespecific', 'mahara', $user->username),
939
                                                'elementtitle' => get_string('delete'),
940 941 942 943 944 945 946 947 948 949
                                            ),
                                    ),
                                )) . '</span>'
                                ,
                'type'         => 'html',
                'key'          => $user->id,
                'class'        => 'actions',
            );
        }
    }
950 951 952 953
    else {
        // no results so hide headings
        $form['elements'] = array();
    }
954 955 956 957 958 959 960 961 962 963 964

    $username = '';
    if ($user  = param_integer('user', 0)) {
        $dbuser = get_record('usr', 'id', $user);
        if (!empty($dbuser)) {
            $username = $dbuser->username;
        }
    }
    else {
        $username = param_alphanum('username', '');
    }
965

966 967
    $pieform = new pieform($form);
    return $pieform->build(false) . '<div id="user_add">' .
968 969
                            pieform(array(
                                'name'            => 'webservices_user_generate',
Naomi Guyer's avatar
Naomi Guyer committed
970
                                'renderer'        => 'div',
971 972 973 974
                                'successcallback' => 'webservices_user_submit',
                                'jsform'          => false,
                                'action'          => get_config('wwwroot') . 'webservice/admin/index.php',
                                'elements' => array(
975 976 977 978
                                    'userid' => array(
                                        'type' => 'autocomplete',
                                        'title' => get_string('username') . ': ',
                                        'ajaxurl' => get_config('wwwroot') . 'webservice/admin/users.json.php',
979
                                        'multiple' => true,
980 981
                                        'allowclear' => true,
                                        'ajaxextraparams' => array(),
982 983 984 985
                                        'extraparams' => array(
                                            'maximumSelectionSize' => 1
                                        ),
                                        'width' => '280px',
986
                                    ),
987 988 989
                                    'action'     => array('type' => 'hidden', 'value' => 'add'),
                                    'submit'     => array(
                                            'type'  => 'submit',
Naomi Guyer's avatar
Naomi Guyer committed
990
                                            'class' => 'submit btn btn-primary last',
991 992 993 994
                                            'value' => get_string('add')
                                        ),
                                ),
                            )).
995
         '</div>';
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
}

/**
 *  Custom webservices config page
 *  - activate/deactivate webservices comletely
 *  - activate/deactivat protocols - SOAP/XML-RPC/REST
 *  - manage service clusters
 *  - manage users and access tokens
 *
 *  @return pieforms $element array
 */
function get_config_options_extended() {

1009
    $protosform = array(
1010 1011
            'name'            => 'activate_webservice_protos',
            'elements'        => webservices_protocol_switch_form(),
1012
    );
1013
    $protos = new Pieform($protosform);
1014 1015 1016 1017 1018 1019 1020 1021 1022

    // certificate values from MNet
    $openssl = OpenSslRepo::singleton();
    $yesno = array(true  => get_string('yes'),
                   false => get_string('no'));

    $elements = array(
            // fieldset of master switch
            'webservicesmaster' => array(
Naomi Guyer's avatar
Naomi Guyer committed
1023 1024 1025 1026
                'type' => 'fieldset',
                'legend' => get_string('protocolswitches', 'auth.webservice'),
                'elements' =>  array(
                    'protos_help' =>  array(
1027 1028
                        'type' => 'html',
                        'value' => '<div><p>' . get_string('manage_protocols', 'auth.webservice') . '</p></div>',
Naomi Guyer's avatar
Naomi Guyer committed
1029
                    ),
1030 1031 1032
                    'masterswitchlabel' =>  array(
                        'type' => 'html',
                        'value' => '<h4 class="mtxl">' . get_string('masterswitch', 'auth.webservice') . '</h4>',
Naomi Guyer's avatar
Naomi Guyer committed
1033
                    ),
1034 1035 1036 1037 1038
                    'webservicesmasterswitchform' => webservices_master_switch_form()['webservicesmasterswitchform'],
                    'enablewebserviceprotos' =>  array(
                        'type' => 'html',
                        'value' => $protos->build(false),
                    )
Naomi Guyer's avatar
Naomi Guyer committed
1039 1040 1041
                ),
                'collapsible' => true,
                'collapsed'   => true,
1042
                'name' => 'activate_webservices',
Naomi Guyer's avatar
Naomi Guyer committed
1043
            ),
1044 1045 1046 1047 1048 1049 1050 1051

            // System Certificates
            'certificates' => array(
                                'type' => 'fieldset',
                                'legend' => get_string('certificates', 'auth.webservice'),
                                'elements' =>  array(
                                                'protos_help' =>  array(
                                                'type' => 'html',
1052
                                                'value' => '<div><p>' . get_string('manage_certificates', 'auth.webservice', get_config('wwwroot') . 'admin/site/networking.php') . '</p></div>',
1053 1054 1055 1056
                                                ),

                                                'pubkey' => array(
                                                    'type'         => 'html',
Naomi Guyer's avatar
Naomi Guyer committed
1057
                                                    'value'        => '<h3 class="title">' . get_string('publickey','admin') . '</h3>' .
1058
                                                                      '<div class="detail">' . get_string('publickeydescription2', 'admin', 365) . '</div>' .
1059
                                                                      '<pre style="font-size: 0.7em; white-space: pre;">' . $openssl->certificate . '</pre>'
1060 1061 1062
                                                ),
                                                'sha1fingerprint' => array(
                                                    'type'         => 'html',
1063
                                                    'value'        => '<div><p>' . get_string('sha1fingerprint', 'auth.webservice', $openssl->sha1_fingerprint) . '</p></div>',
1064 1065 1066
                                                ),
                                                'md5fingerprint' => array(
                                                    'type'         => 'html',
1067
                                                    'value'        => '<div><p>' . get_string('md5fingerprint', 'auth.webservice', $openssl->md5_fingerprint) . '</p></div>',
1068 1069 1070
                                                ),
                                                'expires' => array(
                                                    'type'         => 'html',
1071
                                                    'value'        => '<div><p>' . get_string('publickeyexpireson','auth.webservice', format_date($openssl->expires)) . '</p></div>'
1072 1073 1074 1075
                                                ),
                                            ),
                                'collapsible' => true,
                                'collapsed'   => true,
1076
                                'name' => 'activate_webservices_networking',
1077 1078 1079 1080 1081 1082 1083 1084
                            ),

            // fieldset for managing service function groups
            'servicefunctiongroups' => array(
                                'type' => 'fieldset',
                                'legend' => get_string('servicefunctiongroups', 'auth.webservice'),
                                'elements' => array(
                                    'sfgdescription' => array(
1085
                                        'value' => '<div><p>' . get_string('sfgdescription', 'auth.webservice') . '</p></div>'
1086 1087 1088 1089 1090 1091 1092 1093
                                    ),
                                    'webservicesservicecontainer' => array(
                                        'type'         => 'html',
                                        'value' => service_fg_edit_form(),
                                    )
                                ),
                                'collapsible' => true,
                                'collapsed'   => true,
1094
                                'name' => 'webservices_function_groups',
1095 1096 1097 1098 1099 1100 1101 1102 1103
                            ),


            // fieldset for managing service tokens
            'servicetokens' => array(
                                'type' => 'fieldset',
                                'legend' => get_string('servicetokens', 'auth.webservice'),
                                'elements' => array(
                                    'stdescription' => array(
1104
                                        'value' => '<div><p>' . get_string('stdescription', 'auth.webservice') . '</p></div>'
1105 1106 1107 1108 1109 1110 1111 1112
                                    ),
                                    'webservicestokenscontainer' => array(
                                        'type'         => 'html',
                                        'value' => service_tokens_edit_form(),
                                    )
                                ),
                                'collapsible' => true,
                                'collapsed'   => false,
1113
                                'name' => 'webservices_token',
1114 1115 1116 1117 1118 1119 1120 1121
                            ),

            // fieldset for managing service tokens
            'serviceusers' => array(
                                'type' => 'fieldset',
                                'legend' => get_string('manageserviceusers', 'auth.webservice'),
                                'elements' => array(
                                    'sudescription' => array(
1122
                                        'value' => '<div><p>' . get_string('sudescription', 'auth.webservice') . '</p></div>'
1123 1124 1125 1126