MISP/app/Model/Dashboard.php

<?php
App::uses('AppModel', 'Model');
class Dashboard extends AppModel
{
    public $recursive = -1;

    public $actsAs = array(
            'Containable',
    );

    public $validate = array(
        'user_id' => 'numeric',
        'org_id' => 'numeric',
        'role_id' => 'numeric',
        'uuid' => array(
            'uuid' => array(
                'rule' => 'uuid',
                'message' => 'Please provide a valid RFC 4122 UUID'
            ),
        )
    );

    public $belongsTo = array(
        'User',
        'Role',
        'Organisation' => array(
            'className' => 'Organisation',
            'foreignKey' => 'org_id'
        )
    );

    /**
     * @param array $user
     * @param string $name
     * @param bool $returnOnException
     * @return false|mixed
     */
    public function loadWidget(array $user, $name, $returnOnException = false)
    {
        $name = str_replace('/', '', $name);
        if (file_exists(APP . 'Lib/Dashboard/' . $name . '.php')) {
            App::uses($name, 'Dashboard');
        } else if (file_exists(APP . 'Lib/Dashboard/Custom/' . $name . '.php')) {
            App::uses($name, 'Dashboard/Custom');
        } else {
            $found = false;
            if (file_exists(APP . 'Lib/Dashboard/Custom')) {
                App::uses('Folder', 'Utility');
                $customdir = new Folder(APP . 'Lib/Dashboard/Custom');
                $subDirectories = $customdir->read();
                foreach ($subDirectories[0] as $subDir) {
                    if (file_exists(APP . 'Lib/Dashboard/Custom/' . $subDir . '/' . $name . '.php')) {
                        App::uses($name, 'Dashboard/Custom/' . $subDir);
                        $found = true;
                        break;
                    }
                }
            }
            if (!$found) {
                if ($returnOnException) {
                    return false;
                }
                throw new NotFoundException(__('Invalid widget or widget not found.'));
            }
        }
        $widget = new $name();
        if (method_exists($widget, 'checkPermissions') && !$widget->checkPermissions($user)) {
            if ($returnOnException) {
                return false;
            }
            throw new NotFoundException(__('Invalid widget or widget not found.'));
        }
        return $widget;
    }

    public function loadAllWidgets($user)
    {
        $paths = array(
            '/',
            '/Custom'
        );
        App::uses('Folder', 'Utility');
        $customdir = new Folder(APP . 'Lib/Dashboard/Custom');
        $subDirectories = $customdir->read();
        foreach ($subDirectories[0] as $subDir) {
            $paths[] = '/Custom/' . $subDir;
        }
        $widgets = array();
        foreach ($paths as $path) {
            $currentDir = new Folder(APP . 'Lib/Dashboard' . $path);
            $widgetFiles = $currentDir->find('.*Widget\.php');
            foreach ($widgetFiles as $widgetFile) {
                $className = substr($widgetFile, 0, strlen($widgetFile) -4);
                $temp = $this->__extractMeta($user, $className, $path);
                if ($temp !== false) {
                    $widgets[$className] = $temp;
                }
            }
        }
        ksort($widgets);
        return $widgets;
    }

    private function __extractMeta($user, $className, $path)
    {
        App::uses($className, 'Dashboard' . ($path === '/' ? '' : $path));
        $widgetClass = new $className();
        if (method_exists($widgetClass, 'checkPermissions')) {
            if (!$widgetClass->checkPermissions($user)) {
                return false;
            }
        }
        $widget = array(
            'widget' => $className,
            'title' => $widgetClass->title,
            'render' => $widgetClass->render,
            'params' => empty($widgetClass->params) ? array() : $widgetClass->params,
            'description' => empty($widgetClass->description) ?  $widgetClass->title : $widgetClass->description,
            'height' => empty($widgetClass->height) ? 1 : $widgetClass->height,
            'width' => empty($widgetClass->width) ? 1 : $widgetClass->width,
            'placeholder' => empty($widgetClass->placeholder) ? '' : $widgetClass->placeholder,
            'autoRefreshDelay' => empty($widgetClass->autoRefreshDelay) ? false : $widgetClass->autoRefreshDelay,
        );
        return $widget;
    }

    public function import($user, $value, $targetUser = false)
    {
        $this->User = ClassRegistry::init('User');
        if (empty($targetUser)) {
            $targetUser = $user;
        } else if (!is_array($targetUser)) {
            $targetUser = $this->User->getAuthUser($targetUser);
        }
        if (empty($targetUser)) {
            throw new NotFoundException(__('Invalid user.'));
        }
        $settingsToSave = array();
        foreach ($value as $widgetConfig) {
            $widget = $this->loadWidget($targetUser, $widgetConfig['widget'], true);
            if (!empty($widget)) {
                $settingsToSave[] = $widgetConfig;
            }
        }
        $data = array(
            'UserSetting' => array(
                'user_id' => $targetUser['id'],
                'setting' => 'dashboard',
                'value' => $settingsToSave
            )
        );
        return $this->User->UserSetting->setSetting($user, $data);
    }

    public function export($user)
    {
        $this->User = ClassRegistry::init('User');
        $data = $this->User->UserSetting->find('first', array(
            'recursive' => -1,
            'conditions' => array(
                'UserSetting.user_id' => $user['id'],
                'UserSetting.setting' => 'dashboard'
            )
        ));
        return $data;
    }

    public function getDashboardTemplate($user, $dashboard_id = false)
    {
        if (empty($dashboard_id)) {
            $conditions = array(
                'Dashboard.default' => 1
            );
        } else {
            if (Validation::uuid($dashboard_id)) {
                $conditions = array(
                    'Dashboard.uuid' => $dashboard_id
                );
            } else {
                $conditions = array(
                    'Dashboard.id' => $dashboard_id
                );
            }
        }
        $template = $this->find('first', array(
            'recursive' => -1,
            'conditions' => $conditions
        ));
        if (empty($template)) {
            return array();
        }
        if (empty($user['Role']['perm_site_admin'])) {
            if (
                $template['Dashboard']['user_id'] != $user['id'] &&
                (
                    empty($template['Dashboard']['selectable']) ||
                    (
                        !empty($template['Dashboard']['restrict_to_org_id']) &&
                        $template['Dashboard']['restrict_to_org_id'] != $user['org_id']
                    ) ||
                    (
                        !empty($template['Dashboard']['restrict_to_role_id']) &&
                        $template['Dashboard']['restrict_to_role_id'] != $user['role_id']
                    ) ||
                    (
                        !empty($template['Dashboard']['restrict_to_permission_flag']) &&
                        empty($user['role'][$template['Dashboard']['restrict_to_permission_flag']])
                    )
                )
            ) {
                return array();
            }
        }
        return $template;
    }

    public function saveDashboardTemplate($user, $settings, $update = false)
    {
        $this->User = ClassRegistry::init('User');
        $data = $this->User->UserSetting->find('first', array(
            'recursive' => -1,
            'conditions' => array(
                'UserSetting.user_id' => $user['id'],
                'UserSetting.setting' => 'dashboard'
            )
        ));
        $editableFields = array(
            'name',
            'description',
            'selectable',
            'value'
        );
        if ($user['Role']['perm_site_admin']) {
            $editableFields = array_merge(
                $editableFields,
                array(
                    'default',
                    'restrict_to_role_id',
                    'restrict_to_permission_flag',
                    'restrict_to_org_id'
                )
            );
        }
        if ($update) {
            $existingDashboard = $this->getDashboardTemplate($user, $update);
            if (empty($existingDashboard)) {
                throw new NotFoundException(__('Invalid dashboard template.'));
            }
            $data = $existingDashboard['Dashboard'];
        } else {
            $this->create();
            $data = array(
                'user_id' => $user['id'],
                'uuid' => CakeText::uuid()
            );
            if (empty($user['role']['perm_site_admin'])) {
                $data['restrict_to_org_id'] = $user['org_id'];
            }
        }
        foreach ($editableFields as $editable) {
            if (isset($settings[$editable])) {
                $data[$editable] = $settings[$editable];
            }
        }
        $data['timestamp'] = time();
        if (is_array($data['value'])) {
            $data['value'] = json_encode($data['value']);
        }
        if (!empty($data['default'])) {
            $this->__unsetPreviousDefault();
        }
        return $this->save(array('Dashboard' => $data));
    }

    private function __unsetPreviousDefault()
    {
        $currentDefault = $this->find('first', array(
            'recursive' => -1,
            'conditions' => array(
                'Dashboard.default' => 1
            )
        ));
        if (!empty($currentDefault)) {
            $currentDefault['Dashboard']['default'] = 0;
            $this->save($currentDefault);
        }
        return true;
    }
}