index.php 54.3 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

$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'));

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

30 31
$inlinejs = <<<JS
    jQuery(function ($) {
32 33
        var webservicesenabled = '$serviceenabled';
        var webservicesnotenabled = '$servicenotenabled';
34
        function save_protos_switch(name) {
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
            // 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
53 54 55 56 57 58
            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());
        }

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

        $('#activate_webservices_enabled').on('change', function() {
            var target = $(this).closest('form').siblings('.form-group').find('input:checkbox');
65 66
            if ($(this).is(':checked')) {
                // alert user to switch protocols on if none are active
67 68 69 70 71
                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);
72 73 74
                }
            }
            else {
75 76
                // turn all protocols off
                target.prop('checked', false);
77
                $('#activate_webservices').append('<input type="hidden" name="ajax" value="1">');
78
                $('#activate_webservices_pseudofieldset .form-message-inline').text('');
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
            }
            // 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;

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

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

/* 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();
    }
132 133 134 135 136 137 138
    if (!empty($_POST['ajax'])) {
        $protos = array('soap','xmlrpc','rest','oauth');
        foreach ($protos as $proto) {
            set_config('webservice_'.$proto.'_enabled', 0);
        }
        exit;
    }
139
    redirect('/webservice/admin/index.php?open=activate_webservices');
140 141 142 143 144 145
}

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

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 {
162
            $service = array('name' => $service, 'restrictedusers' => 0, 'enabled' => 0, 'tokenusers' => 0, 'component' => 'webservice', 'ctime' => db_format_timestamp(time()));
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
            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
186
    redirect('/webservice/admin/index.php?open=webservices_function_groups');
187 188 189 190 191 192
}

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

    if ($values['action'] == 'generate') {
193
        if (!empty($values['userid'][0])) {
194
            $dbuser = get_record('usr', 'id', $values['userid'][0]);
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
            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
233
    redirect('/webservice/admin/index.php?open=webservices_token');
234 235 236 237 238 239
}

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

    if ($values['action'] == 'add') {
240
        if (!empty($values['userid'][0])) {
241
            $dbuser = get_record('usr', 'id', $values['userid'][0]);
242 243 244 245 246 247 248 249 250 251 252 253 254 255
            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,
256
                                        'ctime' => db_format_timestamp(time()),
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
                                        '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
292
    redirect('/webservice/admin/index.php?open=webservices_user');
293 294 295 296 297 298 299 300 301 302
}

/**
 * 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);
303 304 305 306
    $element = array(
        'type'  => 'html',
        'value' =>
            pieform(
307
                array(
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
                    'name' => 'activate_webservices',
                    'elementclasses' => false,
                    'class'           => 'form-switch',
                    'successcallback' => 'activate_webservices_submit',
                    'renderer' => 'div',
                    'jsform' => false,
                    'checkdirtychange' => false,
                    'elements' => array(
                        'plugintype' => array('type' => 'hidden', 'value' => 'auth'),
                        'type' => array('type' => 'hidden', 'value' => 'webservice'),
                        'pluginname' => array('type' => 'hidden', 'value' => 'webservice'),
                        'enabled' => array('type' => 'switchbox',
                            'class' => 'last',
                            'value' => $enabled,
                            'labelhtml' => '<span class="pseudolabel">'. get_string('control_webservices', 'auth.webservice') .'</span>',
323
                        ),
324 325 326 327
                    ),
                )
            ),
    );
328

329
    return $element;
330 331 332 333 334 335 336 337 338 339
}

/**
 * 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();
340 341 342 343
    $elements['label'] = array(
        'title' => ' ',
        'type' => 'html',
        'class' => 'fake-form',
344
        'value' => '<h4 class="title">' . get_string('protocol', 'auth.webservice') . '</h4>'
345
    );
346 347 348 349 350 351

    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
352
            'class'            => 'fake-form',
353 354 355 356
            'value' =>
        pieform(array(
            'name'            => 'activate_webservice_protos_' . $proto,
            'elementclasses'  => false,
357
            'class'           => 'form-switch',
358
            'renderer'        => 'div',
359 360
            'successcallback' => 'activate_webservice_proto_submit',
            'jsform'          => false,
361
            'checkdirtychange' => false,
362
            'elements' => array(
363

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

    return $elements;
}

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

387 388
    $editicon = 'icon icon-pencil left';
    $deleteicon = 'icon icon-trash left text-danger';
389

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

    $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(
455 456 457
                'value'        => (($service->enabled == 1) ? display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
458 459 460
                'key'          => $service->name,
            );
            $form['elements']['id'. $service->id . '_restricted'] = array(
461 462 463
                'value' => (($service->restrictedusers == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
464 465 466
                'key'          => $service->name,
            );
            $form['elements']['id'. $service->id . '_tokenusers'] = array(
467 468 469
                'value' => (($service->tokenusers == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
                '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(
488
                'value'        => pieform(array(
489 490
                                    'name'            => 'webservices_function_groups_edit_' . $service->id,
                                    'renderer'        => 'div',
Naomi Guyer's avatar
Naomi Guyer committed
491
                                    'class'  => 'form-as-button pull-left',
492 493 494 495 496 497 498
                                    '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(
499
                                                'type'  => 'button',
500
                                                'class' => 'btn-default btn-sm',
501
                                                'usebuttontag' => true,
Naomi Guyer's avatar
Naomi Guyer committed
502
                                                'value'   => '<span class="'.$editicon.'"></span>' . get_string('edit', 'mahara'),
503
                                                'elementtitle' => get_string('edit'),
504 505 506 507 508 509 510
                                            ),
                                    ),
                                ))
                                .
                                pieform(array(
                                    'name'            => 'webservices_function_groups_delete_' . $service->id,
                                    'renderer'        => 'div',
Naomi Guyer's avatar
Naomi Guyer committed
511
                                    'class'  => 'form-as-button pull-left',
512 513 514 515 516 517 518
                                    '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(
519 520
                                                'type'  => 'button',
                                                'usebuttontag' => true,
521
                                                'class' => 'btn-default btn-sm',
Naomi Guyer's avatar
Naomi Guyer committed
522
                                                'value'   => '<span class="'.$deleteicon.'"></span>' . get_string('delete', 'mahara'),
523
                                                'elementtitle' => get_string('delete'),
524 525
                                            ),
                                    ),
526
                                ))
527 528 529
                                ,
                'type'         => 'html',
                'key'          => $service->name,
530
                'class'        => 'webserviceconfigcontrols btn-group',
531 532 533
            );
        }
    }
534

535
    $pieform = pieform_instance($form);
536
    return $pieform->build(false) . '<div class="function_add">' .
Naomi Guyer's avatar
Naomi Guyer committed
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
        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',
552
                        'class' => 'submit btn-primary last',
Naomi Guyer's avatar
Naomi Guyer committed
553 554 555 556 557
                        'value' => get_string('add')
                    ),
            ),
        )) .
        '</div>';
558 559 560 561 562 563 564 565 566 567
}

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

568 569
    $editicon = 'icon icon-pencil left';
    $deleteicon = 'icon icon-trash left text-danger';
570

571 572 573 574
    $form = array(
        'name'            => 'webservices_tokens',
        'elementclasses'  => false,
        'successcallback' => 'webservices_tokens_submit',
575
        'renderer'   => 'multicolumntable',
576 577 578
        'elements'   => array(
                        'token' => array(
                            'title' => ' ',
579
                            'datatable'  => true,
580 581 582 583 584
                            'type'  => 'html',
                            'value' => get_string('token', 'auth.webservice'),
                        ),
                        'institution' => array(
                            'title' => ' ',
585
                            'datatable'  => true,
586 587 588 589 590
                            'type'  => 'html',
                            'value' => get_string('institution'),
                        ),
                        'username' => array(
                            'title' => ' ',
591
                            'datatable'  => true,
592 593 594 595 596
                            'type'  => 'html',
                            'value' => get_string('username', 'auth.webservice'),
                        ),
                        'servicename' => array(
                            'title' => ' ',
597
                            'datatable'  => true,
598 599 600 601 602
                            'type'  => 'html',
                            'value' => get_string('servicename', 'auth.webservice'),
                        ),
                        'enabled' => array(
                            'title' => ' ',
603
                            'datatable'  => true,
604
                            'type'  => 'html',
605
                            'value' => get_string('enabled'),
606 607 608
                        ),
                        'wssigenc' => array(
                            'title' => ' ',
609
                            'datatable'  => true,
610 611 612 613 614
                            'type'  => 'html',
                            'value' => get_string('titlewssigenc', 'auth.webservice'),
                        ),
                        'functions' => array(
                            'title' => ' ',
615
                            'datatable'  => true,
616 617 618
                            'type'  => 'html',
                            'value' => get_string('functions', 'auth.webservice'),
                        ),
619 620 621 622 623 624
                        'actions' => array(
                            'title' => ' ',
                            'datatable'  => true,
                            'type'  => 'html',
                            'value' => '',
                        ),
625 626 627 628 629 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
                    ),
        );

    $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(
659 660 661
                'value' => (($token->enabled == 1) ? display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
662 663 664
                'key'          => $token->token,
            );
            $form['elements']['id'. $token->tokenid . '_wssigenc'] = array(
665 666 667
                'value' => (($token->wssigenc == 1) ? display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
                '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(
687
                'value'        => pieform(array(
688 689 690 691
                                    'name'            => 'webservices_token_edit_' . $token->tokenid,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_token_submit',
692
                                    'class'           => 'form-as-button pull-left',
693
                                    'jsform'          => false,
694 695 696 697
                                    'elements' => array(
                                        'token'      => array('type' => 'hidden', 'value' => $token->tokenid),
                                        'action'     => array('type' => 'hidden', 'value' => 'edit'),
                                        'submit'     => array(
698 699
                                                'type'  => 'button',
                                                'usebuttontag' => true,
700
                                                'class' => 'btn-default btn-sm',
701 702
                                                'value'   => '<span class="'.$editicon.'"></span>' . get_string('edit'),
                                                'elementtitle' => get_string('editspecific', 'mahara', $token->tokenid),
703 704 705 706 707 708 709 710 711
                                            ),
                                    ),
                                ))
                                .
                                pieform(array(
                                    'name'            => 'webservices_token_delete_' . $token->tokenid,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_token_submit',
712
                                    'class'           => 'form-as-button pull-left',
713
                                    'jsform'          => false,
714 715 716 717
                                    'elements' => array(
                                        'token'      => array('type' => 'hidden', 'value' => $token->tokenid),
                                        'action'     => array('type' => 'hidden', 'value' => 'delete'),
                                        'submit'     => array(
718 719
                                                'type'  => 'button',
                                                'usebuttontag' => true,
720
                                                'class' => 'btn-default btn-sm',
721 722
                                                'value'   => '<span class="'.$deleteicon.'"></span>' . get_string('delete'),
                                                'elementtitle' => get_string('deletespecific', 'mahara', $token->tokenid),
723 724
                                            ),
                                    ),
725
                                )),
726 727
                'type'         => 'html',
                'key'          => $token->token,
728
                'class'        => 'webserviceconfigcontrols btn-group',
729 730 731
            );
        }
    }
732 733 734 735
    else {
        // no results so hide headings
        $form['elements'] = array();
    }
736 737 738 739 740 741 742 743 744 745 746

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

}

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

788 789
    $editicon = 'icon icon-pencil left';
    $deleteicon = 'icon icon-trash left text-danger';
790

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

842
    $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());
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
    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(
868 869 870
                'value' => (($user->enabled == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
871 872 873
                'key'          => $user->id,
            );
            $form['elements']['id'. $user->id . '_wssigenc'] = array(
874 875 876
                'value' => (($user->wssigenc == 1) ?  display_icon('enabled') : display_icon('disabled')),
                'type'         => 'html',
                'class'        => 'center',
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
                '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(
896
                'value'        => pieform(array(
897 898 899 900
                                    'name'            => 'webservices_user_edit_' . $user->id,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_user_submit',
901
                                    'class'           => 'form-as-button pull-left',
902
                                    'jsform'          => false,
903 904 905 906
                                    'elements' => array(
                                        'suid'       => array('type' => 'hidden', 'value' => $user->id),
                                        'action'     => array('type' => 'hidden', 'value' => 'edit'),
                                        'submit'     => array(
907 908
                                                'type'  => 'button',
                                                'usebuttontag' => true,
909
                                                'class' => 'btn-default btn-sm',
910
                                                'value'   => '<span class="'. $editicon.'" role="presentation" aria-hidden="true"></span>' . get_string('edit'),
911
                                                'elementtitle' => get_string('editspecific', 'mahara', $user->username),
912 913 914 915 916 917 918 919 920
                                            ),
                                    ),
                                ))
                                .
                                pieform(array(
                                    'name'            => 'webservices_user_delete_' . $user->id,
                                    'renderer'        => 'div',
                                    'elementclasses'  => false,
                                    'successcallback' => 'webservices_user_submit',
921
                                    'class'           => 'form-as-button pull-left',
922
                                    'jsform'          => false,
923 924 925 926
                                    'elements' => array(
                                        'suid'       => array('type' => 'hidden', 'value' => $user->id),
                                        'action'     => array('type' => 'hidden', 'value' => 'delete'),
                                        'submit'     => array(
927 928
                                                'type'  => 'button',
                                                'usebuttontag' => true,
929
                                                'class' => 'btn-default btn-sm',
930
                                                'value'   => '<span class="'.$deleteicon.'" role="presentation" aria-hidden="true"></span>' . get_string('delete'),
931
                                                'elementtitle' => get_string('deletespecific', 'mahara', $user->username),
932 933
                                            ),
                                    ),
934
                                )),
935 936
                'type'         => 'html',
                'key'          => $user->id,
937
                'class'        => 'webserviceconfigcontrols btn-group',
938 939 940
            );
        }
    }
941 942 943 944
    else {
        // no results so hide headings
        $form['elements'] = array();
    }
945 946 947 948 949 950 951 952 953 954 955

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

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

/**
 *  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() {

1000
    $protosform = array(
1001 1002
            'name'            => 'activate_webservice_protos',
            'elements'        => webservices_protocol_switch_form(),
1003
    );
1004
    $protos = pieform_instance($protosform);
1005 1006 1007 1008 1009 1010 1011

    // certificate values from MNet
    $openssl = OpenSslRepo::singleton();

    $elements = array(
            // fieldset of master switch
            'webservicesmaster' => array(
Naomi Guyer's avatar
Naomi Guyer committed
1012 1013 1014 1015
                'type' => 'fieldset',
                'legend' => get_string('protocolswitches', 'auth.webservice'),
                'elements' =>  array(
                    'protos_help' =>  array(
1016 1017
                        'type' => 'html',
                        'value' => '<div><p>' . get_string('manage_protocols', 'auth.webservice') . '</p></div>',
Naomi Guyer's avatar
Naomi Guyer committed
1018
                    ),
1019 1020
                    'masterswitchlabel' =>  array(
                        'type' => 'html',
1021
                        'value' => '<h4>' . get_string('masterswitch', 'auth.webservice') . '</h4>',
Naomi Guyer's avatar
Naomi Guyer committed
1022
                    ),
1023
                    'webservicesmasterswitchform' => webservices_master_switch_form(),
1024 1025 1026 1027
                    'enablewebserviceprotos' =>  array(
                        'type' => 'html',
                        'value' => $protos->build(false),
                    )
Naomi Guyer's avatar
Naomi Guyer committed
1028 1029 1030
                ),
                'collapsible' => true,
                'collapsed'   => true,
1031
                'name' => 'activate_webservices',
Naomi Guyer's avatar
Naomi Guyer committed
1032
            ),
1033 1034 1035 1036 1037 1038 1039 1040

            // System Certificates
            'certificates' => array(
                                'type' => 'fieldset',
                                'legend' => get_string('certificates', 'auth.webservice'),
                                'elements' =>  array(
                                                'protos_help' =>  array(
                                                'type' => 'html',
1041
                                                'value' => '<div><p>' . get_string('manage_certificates', 'auth.webservice', get_config('wwwroot') . 'admin/site/networking.php') . '</p></div>',
1042 1043 1044 1045
                                                ),

                                                'pubkey' => array(
                                                    'type'         => 'html',
Naomi Guyer's avatar
Naomi Guyer committed
1046
                                                    'value'        => '<h3 class="title">' . get_string('publickey','admin') . '</h3>' .
1047
                                                                      '<div class="detail">' . get_string('publickeydescription2', 'admin', 365) . '</div>' .
1048
                                                                      '<pre style="font-size: 0.7em; white-space: pre;">' . $openssl->certificate . '</pre>'
1049 1050 1051
                                                ),
                                                'sha1fingerprint' => array(
                                                    'type'         => 'html',
1052
                                                    'value'        => '<div><p>' . get_string('sha1fingerprint', 'auth.webservice', $openssl->sha1_fingerprint) . '</p></div>',
1053 1054 1055
                                                ),
                                                'md5fingerprint' => array(
                                                    'type'         => 'html',
1056
                                                    'value'        => '<div><p>' . get_string('md5fingerprint', 'auth.webservice', $openssl->md5_fingerprint) . '</p></div>',
1057 1058 1059
                                                ),
                                                'expires' => array(
                                                    'type'         => 'html',
1060
                                                    'value'        => '<div><p>' . get_string('publickeyexpireson','auth.webservice', format_date($openssl->expires)) . '</p></div>'
1061 1062 1063 1064
                                                ),
                                            ),
                                'collapsible' => true,
                                'collapsed'   => true,
1065
                                'name' => 'activate_webservices_networking',
1066 1067 1068 1069 1070 1071 1072 1073
                            ),

            // fieldset for managing service function groups
            'servicefunctiongroups' => array(
                                'type' => 'fieldset',
                                'legend' => get_string('servicefunctiongroups', 'auth.webservice'),