cardwallPlugin::agiledashboard_event_additional_panes_info_on_milestone() - Code Metrics - Enalean/tuleap - Measure and Improve Code Quality continuously with Scrutinizer

agiledashboard_event_additional_panes_info_on_milestone() A
last analyzed 2016-01-22 17:23 UTC

↳ Parent: cardwallPlugin
Complexity

Conditions	2
Paths	2
Size

Total Lines	9
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Metric	Value
dl	0
loc	9
rs	9.6666
cc	2
eloc	5
nc	2
nop	1
<?php
/**
 * Copyright (c) Enalean, 2011. All Rights Reserved.
 *
 * This file is a part of Tuleap.
 *
 * Tuleap is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Tuleap is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Tuleap. If not, see <http://www.gnu.org/licenses/>.
 */

require_once 'common/plugin/Plugin.class.php';
require_once 'constants.php';
require_once 'autoload.php';

/**
 * CardwallPlugin
 */
class cardwallPlugin extends Plugin {
    
    /** 
     * @var Cardwall_OnTop_ConfigFactory
     */
    private $config_factory;
    
    public function getConfigFactory() {
        if (!$this->config_factory) {
            $tracker_factory  = TrackerFactory::instance();
            $element_factory  = Tracker_FormElementFactory::instance();
            $this->config_factory = new Cardwall_OnTop_ConfigFactory($tracker_factory, $element_factory);
        }
        return $this->config_factory;
    }

    const RENDERER_TYPE = 'plugin_cardwall';


    public function getHooksAndCallbacks() {
        if (defined('TRACKER_BASE_URL')) {
            $this->addHook('cssfile');
            $this->addHook('javascript_file');
            $this->addHook('tracker_report_renderer_types');
            $this->addHook('tracker_report_renderer_instance');
            $this->addHook(TRACKER_EVENT_TRACKERS_DUPLICATED);
            $this->addHook(TRACKER_EVENT_BUILD_ARTIFACT_FORM_ACTION);
            $this->addHook(TRACKER_EVENT_REDIRECT_AFTER_ARTIFACT_CREATION_OR_UPDATE);
            $this->_addHook(Event::JAVASCRIPT);
            $this->addHook(Event::IMPORT_XML_PROJECT_TRACKER_DONE);
            $this->addHook(TRACKER_EVENT_MANAGE_SEMANTICS);
            $this->addHook(TRACKER_EVENT_SEMANTIC_FROM_XML);
            $this->addHook(TRACKER_EVENT_GET_SEMANTIC_FACTORIES);

            if (defined('AGILEDASHBOARD_BASE_DIR')) {
                $this->addHook(AGILEDASHBOARD_EVENT_ADDITIONAL_PANES_ON_MILESTONE);
                $this->addHook(AGILEDASHBOARD_EVENT_ADDITIONAL_PANES_INFO_ON_MILESTONE);
                $this->addHook(AGILEDASHBOARD_EVENT_INDEX_PAGE);
                $this->addHook(AGILEDASHBOARD_EVENT_MILESTONE_SELECTOR_REDIRECT);
                $this->addHook(AGILEDASHBOARD_EVENT_PLANNING_CONFIG);
                $this->addHook(AGILEDASHBOARD_EVENT_PLANNING_CONFIG_UPDATE);
                $this->addHook(AGILEDASHBOARD_EVENT_REST_GET_CARDWALL);
                $this->addHook(AGILEDASHBOARD_EVENT_REST_GET_MILESTONE);
                $this->addHook(AGILEDASHBOARD_EVENT_IS_CARDWALL_ENABLED);
                $this->addHook(AGILEDASHBOARD_EVENT_GET_CARD_FIELDS);
                $this->addHook(AGILEDASHBOARD_EVENT_REST_RESOURCES);
                $this->addHook(AGILEDASHBOARD_EXPORT_XML);
            }
        }
        return parent::getHooksAndCallbacks();
    }

    /**
     * @see Plugin::getDependencies()
     */
    public function getDependencies() {
        return array('tracker');
    }

    
    // TODO : transform into a OnTop_Config_Command, and move code to ConfigFactory
    public function tracker_event_trackers_duplicated($params) {
        foreach ($params['tracker_mapping'] as $from_tracker_id => $to_tracker_id) {
            if ($this->getOnTopDao()->duplicate($from_tracker_id, $to_tracker_id)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                $this->getOnTopColumnDao()->duplicate($from_tracker_id, $to_tracker_id, $params);
                $this->getOnTopColumnMappingFieldDao()->duplicate($from_tracker_id, $to_tracker_id, $params['tracker_mapping'], $params['field_mapping']);
                $this->getOnTopColumnMappingFieldValueDao()->duplicate($from_tracker_id, $to_tracker_id, $params['tracker_mapping'], $params['field_mapping'], $params['plugin_cardwall_column_mapping']);
            }
        }
    }

    /**
     * This hook ask for types of report renderer
     *
     * @param array types Input/Output parameter. Expected format: $types['my_type'] => 'Label of the type'
     */
    public function tracker_report_renderer_types($params) {
        $params['types'][self::RENDERER_TYPE] = $GLOBALS['Language']->getText('plugin_cardwall', 'title');
    }

    /**
     * This hook asks to create a new instance of a renderer
     *
     * @param array $params:
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *              mixed  'instance' Output parameter. must contain the new instance
     *              string 'type' the type of the new renderer
     *              array  'row' the base properties identifying the renderer (id, name, description, rank)
     *              Report 'report' the report
     *
     * @return void
     */
    public function tracker_report_renderer_instance($params) {
        if ($params['type'] == self::RENDERER_TYPE) {
            //First retrieve specific properties of the renderer that are not saved in the generic table
            if ( !isset($row['field_id']) ) {

                $row['field_id'] = null;
                if ($params['store_in_session']) {
                    $this->report_session = new Tracker_Report_Session($params['report']->id);
                    $this->report_session->changeSessionNamespace("renderers.{$params['row']['id']}");
                    $row['field_id'] = $this->report_session->get("field_id");
                }
                if (!$row['field_id']) {
                    $dao = new Cardwall_RendererDao();
                    $cardwall_row = $dao->searchByRendererId($params['row']['id'])->getRow();
                    if ($cardwall_row) {
                        $row['field_id'] = $cardwall_row['field_id'];
                    }
                }
            }

            $report = $params['report'];
            $config = new Cardwall_OnTop_ConfigEmpty();
            
            if ($report->tracker_id != 0) {
                $config = $this->getConfigFactory()->getOnTopConfigByTrackerId($report->tracker_id);
            }
            //Build the instance from the row
            $params['instance'] = new Cardwall_Renderer(
                $this,
                $config,
                $params['row']['id'],
                $params['report'],
                $params['row']['name'],
                $params['row']['description'],
                $params['row']['rank'],
                $row['field_id'],
                $this->getPluginInfo()->getPropVal('display_qr_code')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            );
            if ($params['store_in_session']) {
                $params['instance']->initiateSession();
            }
        }
    }

    public function getPluginInfo() {
        if (!is_a($this->pluginInfo, 'CardwallPluginInfo')) {
            $this->pluginInfo = new CardwallPluginInfo($this);
        }
        return $this->pluginInfo;
    }

    public function cssfile($params) {
        // Only show the stylesheet if we're actually in the Cardwall pages.
        // This stops styles inadvertently clashing with the main site.
        if ($this->isAgileDashboardOrTrackerUrl() ||
            strpos($_SERVER['REQUEST_URI'], '/my/') === 0 ||
            strpos($_SERVER['REQUEST_URI'], '/projects/') === 0 ||
            strpos($_SERVER['REQUEST_URI'], '/widgets/') === 0 ) {
            echo '<link rel="stylesheet" type="text/css" href="'. $this->getThemePath() .'/css/style.css" />';
        }
    }

    public function javascript_file($params) {
        // Only show the js if we're actually in the Cardwall pages.
        // This stops styles inadvertently clashing with the main site.
        if ($this->isAgileDashboardOrTrackerUrl() && $this->canUseStandardJavsacript()) {
            echo $this->getJavascriptIncludesForScripts(array(
                'ajaxInPlaceEditorExtensions.js',
                'cardwall.js',
                'script.js',
                'custom-mapping.js',
                'CardsEditInPlace.js',
                'fullscreen.js',
            ));
        }
    }

    /**
     * @see Event::TRACKER_EVENT_MANAGE_SEMANTICS
     */
    public function tracker_event_manage_semantics($parameters) {
        $tracker   = $parameters['tracker'];
        /* @var $semantics Tracker_SemanticCollection */
        $semantics = $parameters['semantics'];


        $card_fields_semantic = Cardwall_Semantic_CardFields::load($tracker);
        $semantics->add($card_fields_semantic->getShortName(), $card_fields_semantic);
    }

    /**
     * @see TRACKER_EVENT_SEMANTIC_FROM_XML
     */
    public function tracker_event_semantic_from_xml($params) {
        $tracker     = $params['tracker'];
        $xml         = $params['xml'];
        $xml_mapping = $params['xml_mapping'];
        $type        = $params['type'];

        if ($type == Cardwall_Semantic_CardFields::NAME) {
            $params['semantic'] = Cardwall_Semantic_CardFieldsFactory::instance()->getInstanceFromXML($xml, $xml_mapping, $tracker);
        }
    }

    /**
     * @see TRACKER_EVENT_GET_SEMANTIC_FACTORIES
     */
    public function tracker_event_get_semantic_factories($params) {
        $params['factories'][] = Cardwall_Semantic_CardFieldsFactory::instance();
    }

    private function getJavascriptIncludesForScripts(array $script_names) {
        $html = '';
        foreach ($script_names as $script_name) {
            $html .= '<script type="text/javascript" src="'.$this->getPluginPath().'/js/'.$script_name.'"></script>'."\n";
        }
        return $html;
    }

    private function isAgileDashboardOrTrackerUrl() {
        return (defined('AGILEDASHBOARD_BASE_DIR') &&
                strpos($_SERVER['REQUEST_URI'], AGILEDASHBOARD_BASE_URL.'/') === 0 ||
                strpos($_SERVER['REQUEST_URI'], TRACKER_BASE_URL.'/') === 0);
    }

    private function canUseStandardJavsacript() {
        $use_standard = true;

        $em = EventManager::instance();
        $em->processEvent(
            CARDWALL_EVENT_USE_STANDARD_JAVASCRIPT,
            array(
                'use_standard' => &$use_standard
            )
        );

        return $use_standard;
    }

    public function javascript($params) {
        include $GLOBALS['Language']->getContent('script_locale', null, 'cardwall', '.js');
        echo "var tuleap = tuleap || { };".PHP_EOL;
        echo "tuleap.cardwall = tuleap.cardwall || { };".PHP_EOL;
        echo "tuleap.cardwall.base_url = '". CARDWALL_BASE_URL ."/';".PHP_EOL;
        echo PHP_EOL;
    }

    private function denyAccess($tracker_id) {

        $GLOBALS['Response']->addFeedback('error', $GLOBALS['Language']->getText('plugin_tracker_admin', 'access_denied'));
        $GLOBALS['Response']->redirect(TRACKER_BASE_URL.'/?tracker='. $tracker_id);
    }

    /**
     * @see Event::AGILEDASHBOARD_EVENT_GET_CARD_FIELDS
     */
    public function agiledashboard_event_get_card_fields($parameters) {
        $parameters['card_fields_semantic'] = Cardwall_Semantic_CardFields::load($parameters['tracker']);
    }

    public function agiledashboard_event_additional_panes_on_milestone($params) {
        $pane_info = $this->getPaneInfo($params['milestone']);

        if (! $pane_info) {
            return;
        }

        if ($params['request']->get('pane') == Cardwall_PaneInfo::IDENTIFIER) {
            $pane_info->setActive(true);
            $params['active_pane'] = $this->getCardwallPane($pane_info, $params['milestone'], $params['user'], $params['milestone_factory']);
        }
        $params['panes'][] = $pane_info;
    }

    public function agiledashboard_event_additional_panes_info_on_milestone($params) {
        $pane_info = $this->getPaneInfo($params['milestone']);

        if (! $pane_info) {
            return;
        }

        $params['pane_info_list'][] = $pane_info;
    }

    private function getPaneInfo($milestone) {
        $tracker  = $milestone->getArtifact()->getTracker();

        if (! $this->getOnTopDao()->isEnabled($tracker->getId())) {
            return;
        }

        return new Cardwall_PaneInfo($milestone, $this->getThemePath());
    }

    public function agiledashboard_event_index_page($params) {
        // Only display a cardwall if there is something to display
        if ($params['milestone'] && $params['milestone']->getPlannedArtifacts() && count($params['milestone']->getPlannedArtifacts()->getChildren()) > 0) {
            $pane_info = new Cardwall_PaneInfo($params['milestone'], $this->getThemePath());
            $params['pane'] = $this->getCardwallPane($pane_info, $params['milestone'], $params['user'], $params['milestone_factory']);
        }
    }

    protected function getCardwallPane(Cardwall_PaneInfo $info, Planning_Milestone $milestone, PFUser $user, Planning_MilestoneFactory $milestone_factory) {
        $config = $this->getConfigFactory()->getOnTopConfigByPlanning($milestone->getPlanning());
        if ($config) {
            return new Cardwall_Pane(
                $info,
                $milestone,
                $config,
                $user,
                $milestone_factory
            );
        }
        return null;
    }

    public function agiledashboard_event_milestone_selector_redirect($params) {
        if ($params['milestone']->getArtifact()) {
            $tracker  = $params['milestone']->getArtifact()->getTracker();
            if ($this->getOnTopDao()->isEnabled($tracker->getId())) {
                $params['redirect_parameters']['pane'] = 'cardwall';
            }
        }
    }

    public function tracker_event_redirect_after_artifact_creation_or_update($params) {
        $cardwall = $params['request']->get('cardwall');
        $redirect = $params['redirect'];
        if ($cardwall) {
            if (!$redirect->stayInTracker()) {
                list($redirect_to, $redirect_params) = each($cardwall);
                switch ($redirect_to) {
                case 'agile':
                    $this->redirectToAgileDashboard($redirect, $redirect_params);
                    break;
                case 'renderer':
                    $this->redirectToRenderer($redirect, $redirect_params);
                    break;
                }
            } else {
                $this->appendCardwallParameter($redirect, $cardwall);
            }
        }
    }

    private function redirectToAgileDashboard(Tracker_Artifact_Redirect $redirect, array $redirect_params) {
        list($planning_id, $artifact_id) = each($redirect_params);
        $planning = PlanningFactory::build()->getPlanning($planning_id);
        if ($planning) {
            $redirect->base_url         = AGILEDASHBOARD_BASE_URL;
            $redirect->query_parameters = array(
                'group_id'    => $planning->getGroupId(),
                'planning_id' => $planning->getId(),
                'action'      => 'show',
                'aid'         => $artifact_id,
                'pane'        => 'cardwall',
            );
        }
    }

    private function redirectToRenderer(Tracker_Artifact_Redirect $redirect, array $redirect_params) {
        list($report_id, $renderer_id) = each($redirect_params);
        $redirect->base_url            = TRACKER_BASE_URL;
        $redirect->query_parameters    = array(
            'report'   => $report_id,
            'renderer' => $renderer_id,
        );
    }

    public function tracker_event_build_artifact_form_action($params) {
        $cardwall = $params['request']->get('cardwall');
        if ($cardwall) {
            $this->appendCardwallParameter($params['redirect'], $cardwall);
        }
    }

    private function appendCardwallParameter(Tracker_Artifact_Redirect $redirect, $cardwall) {
        list($key, $value) = explode('=', urldecode(http_build_query(array('cardwall' => $cardwall))));
        $redirect->query_parameters[$key] = $value;
    }

    /**
     * @param array $params parameters send by Event
     * Parameters:
     *  'project'  => The given project
     *  'into_xml' => The SimpleXMLElement to fill in
     */
    public function agiledashboard_export_xml ($params) {
        $tracker_factory = TrackerFactory::instance();

        $cardwall_xml_export = new CardwallConfigXmlExport(
            $params['project'],
            $tracker_factory,
            $this->getConfigFactory(),
            new XML_RNGValidator()
        );

        $cardwall_xml_export->export($params['into_xml']);
    }

    /**
     *
     * @param array $params
     * @see Event::IMPORT_XML_PROJECT_TRACKER_DONE
     */
    public function import_xml_project_tracker_done($params) {
        $cardwall_ontop_import = new CardwallConfigXmlImport(
            $params['project_id'],
            $params['mapping'],
            new Cardwall_OnTop_Dao,
            new Cardwall_OnTop_ColumnDao,
            EventManager::instance(),
            new XML_RNGValidator()
        );
        $cardwall_ontop_import->import($params['xml_content']);
    }

    public function agiledashboard_event_rest_get_milestone($params) {
        $config = $this->getConfigFactory()->getOnTopConfig($params['milestone']->getPlanning()->getPlanningTracker());
        if ($config && $config->isEnabled()) {
            $params['milestone_representation']->enableCardwall();
        }
    }

    private function buildRightVersionOfMilestonesCardwallResource($version) {
        $class_with_right_namespace = '\\Tuleap\\Cardwall\\REST\\'.$version.'\\MilestonesCardwallResource';
        return new $class_with_right_namespace($this->getConfigFactory());
    }

    public function agiledashboard_event_rest_get_cardwall($params) {
        $milestones_cardwall = $this->buildRightVersionOfMilestonesCardwallResource($params['version']);

        $params['cardwall'] = $milestones_cardwall->get($params['milestone']);

    }

    /**
     * Fetches HTML
     *
     * @param array $params parameters sent by Event
     *
     * Parameters:
     *  'tracker' => The planning tracker
     *  'view'    => A string of HTML
     */
    public function agiledashboard_event_planning_config($params) {
        $tracker = $params['tracker'];
        $config  = $this->getConfigFactory()->getOnTopConfig($tracker);

        $admin_view = new Cardwall_OnTop_Config_View_Admin();
        $params['view'] = $admin_view->displayAdminOnTop($config);
    }

    public function agiledashboard_event_is_cardwall_enabled($params) {
        $tracker = $params['tracker'];
        $params['enabled'] = $this->getConfigFactory()
            ->isOnTopConfigEnabledForPlanning($tracker);
    }

    /**
     * @param array $params parameters sent by Event
     *
     * Parameters:
     *  'tracker' => The planning tracker
     *  'request' => The Request
     */
    public function agiledashboard_event_planning_config_update($params) {
        $request = $params['request'];
        $request->set('use_freestyle_columns', 1);

        $this->getConfigFactory()->getOnTopConfigUpdater($params['tracker'])
                ->process($request);
    }

    /**
     * @return Cardwall_OnTop_Dao
     */
    private function getOnTopDao() {
        return new Cardwall_OnTop_Dao();
    }

    /**
     * @return Cardwall_OnTop_ColumnDao
     */
    private function getOnTopColumnDao() {
        return new Cardwall_OnTop_ColumnDao();
    }

    /**
     * @return Cardwall_OnTop_ColumnMappingFieldDao
     */
    private function getOnTopColumnMappingFieldDao() {
        return new Cardwall_OnTop_ColumnMappingFieldDao();
    }

    /**
     * @return Cardwall_OnTop_ColumnMappingFieldValueDao
     */
    private function getOnTopColumnMappingFieldValueDao() {
        return new Cardwall_OnTop_ColumnMappingFieldValueDao();
    }

    public function process(Codendi_Request $request) {
        switch($request->get('action')) {
            case 'toggle_user_autostack_column':
                $display_preferences_controller = new Cardwall_UserPreferences_UserPreferencesController($request);
                $display_preferences_controller->toggleAutostack();
                break;

            case 'toggle_user_display_avatar':
                $display_preferences_controller = new Cardwall_UserPreferences_UserPreferencesController($request);
                $display_preferences_controller->toggleUserDisplay();
                break;

            case 'get-card':
                try {
                    $single_card_builder = new Cardwall_SingleCardBuilder(
                        $this->getConfigFactory(),
                        new Cardwall_CardFields(
                            UserManager::instance(),
                            Tracker_FormElementFactory::instance()
                        ),
                        Tracker_ArtifactFactory::instance(),
                        PlanningFactory::build()
                    );
                    $controller = new Cardwall_CardController(
                        $request,
                        $single_card_builder->getSingleCard(
                            $request->getCurrentUser(),
                            $request->getValidated('id', 'uint', 0),
                            $request->getValidated('planning_id', 'uint', 0)
                        )
                    );
                    $controller->getCard();
                } catch (Exception $exception) {
                    $GLOBALS['Response']->addFeedback(Feedback::ERROR, $exception->getMessage());
                    $GLOBALS['Response']->sendStatusCode(400);
                }
                break;

            default:
                echo 'Hello !';
        }
    }

    public function agiledashboard_event_rest_resources($params) {
        $injector = new Cardwall_REST_ResourcesInjector();
        $injector->populate($params['restler']);
    }
}
GitHub Access Token became invalid

agiledashboard_event_additional_panes_info_on_milestone() A
last analyzed 2016-01-22 17:23 UTC

Complexity

Size

Duplication

Available Fixes

Enalean / tuleap

GitHub Access Token became invalid

agiledashboard_event_additional_panes_info_on_milestone() A last analyzed 2016-01-22 17:23 UTC

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like

agiledashboard_event_additional_panes_info_on_milestone() A
last analyzed 2016-01-22 17:23 UTC
