+global\contentBlueprintsDatasources::__formAction()

Complexity

Conditions	54
Paths	> 20000

Size

Total Lines	365
Code Lines	192

Duplication

Lines	116
Ratio	31.78 %

Importance

Changes	3
Bugs	0	Features	0

<?php
        public function __formAction()

__formAction uses the super-global variable $_POST which is generally not recommended.

        {
            $fields = $_POST['fields'];
            $this->_errors = array();
            $providers = Symphony::ExtensionManager()->getProvidersOf(iProvider::DATASOURCE);
            $providerClass = null;

            if (trim($fields['name']) === '') {
                $this->_errors['name'] = __('This is a required field');
            }

            if ($fields['source'] === 'static_xml') {
                if (trim($fields['static_xml']) === '') {
                    $this->_errors['static_xml'] = __('This is a required field');
                } else {
                    $xml_errors = null;

                    include_once TOOLKIT . '/class.xsltprocess.php';

                    General::validateXML($fields['static_xml'], $xml_errors, false, new XsltProcess());

                    if (!empty($xml_errors)) {
                        $this->_errors['static_xml'] = __('XML is invalid.');
                    }
                }
            } elseif (is_numeric($fields['source'])) {
                if (strlen(trim($fields['max_records'])) === 0 || (is_numeric($fields['max_records']) && $fields['max_records'] < 1)) {
                    if ($fields['paginate_results'] === 'yes') {
                        $this->_errors['max_records'] = __('A result limit must be set');
                    }
                } elseif (!self::__isValidPageString($fields['max_records'])) {
                    $this->_errors['max_records'] = __('Must be a valid number or parameter');
                }

                if (strlen(trim($fields['page_number'])) === 0 || (is_numeric($fields['page_number']) && $fields['page_number'] < 1)) {
                    if ($fields['paginate_results'] === 'yes') {
                        $this->_errors['page_number'] = __('A page number must be set');
                    }
                } elseif (!self::__isValidPageString($fields['page_number'])) {
                    $this->_errors['page_number'] = __('Must be a valid number or parameter');
                }

                // See if a Provided Datasource is saved
            } elseif (!empty($providers)) {
                foreach ($providers as $providerClass => $provider) {
                    if ($fields['source'] === call_user_func(array($providerClass, 'getSource'))) {
                        call_user_func_array(array($providerClass, 'validate'), array(&$fields, &$this->_errors));
                        break;
                    }

                    unset($providerClass);
                }
            }

            $classname = Lang::createHandle($fields['name'], 255, '_', false, true,
                array('@^[^a-z\d]+@i' => '', '/[^\w-\.]/i' => ''));
            $rootelement = str_replace('_', '-', $classname);

            // Check to make sure the classname is not empty after handlisation.
            if (empty($classname) && !isset($this->_errors['name'])) {
                $this->_errors['name'] = __('Please ensure name contains at least one Latin-based character.',
                    array($classname));
            }

            $file = DATASOURCES . '/data.' . $classname . '.php';

            $isDuplicate = false;
            $queueForDeletion = null;

            if ($this->_context['action'] === 'new' && is_file($file)) {
                $isDuplicate = true;
            } elseif ($this->_context['action'] === 'edit') {
                $existing_handle = $this->_context['handle'];

                if ($classname !== $existing_handle && is_file($file)) {
                    $isDuplicate = true;
                } elseif ($classname !== $existing_handle) {
                    $queueForDeletion = DATASOURCES . '/data.' . $existing_handle . '.php';
                }
            }

            // Duplicate
            if ($isDuplicate) {
                $this->_errors['name'] = __('A Data source with the name %s already exists',
                    array('<code>' . $classname . '</code>'));
            }

            if (empty($this->_errors)) {
                $filters = array();
                $elements = null;
                $source = $fields['source'];
                $params = array(
                    'rootelement' => $rootelement
                );

                $about = array(
                    'name' => $fields['name'],
                    'version' => 'Symphony ' . Symphony::Configuration()->get('version', 'symphony'),
                    'release date' => DateTimeObj::getGMT('c'),
                    'author name' => Symphony::Author()->getFullName(),
                    'author website' => URL,
                    'author email' => Symphony::Author()->get('email')
                );

                // If there is a provider, get their template
                if ($providerClass) {
                    $dsShell = file_get_contents(call_user_func(array($providerClass, 'getTemplate')));
                } else {
                    $dsShell = file_get_contents($this->getTemplate('blueprints.datasource'));
                }

                // Author metadata
                self::injectAboutInformation($dsShell, $about);

                // Do dependencies, the template file must have <!-- CLASS NAME -->
                $dsShell = str_replace('<!-- CLASS NAME -->', $classname, $dsShell);

                // If there is a provider, let them do the prepartion work
                if ($providerClass) {
                    $dsShell = call_user_func(array($providerClass, 'prepare'), $fields, $params, $dsShell);
                } else {
                    switch ($source) {
                        case 'authors':
                            $extends = 'AuthorDatasource';
                            if (isset($fields['filter']['author'])) {
                                $filters = $fields['filter']['author'];
                            }

                            $elements = $fields['xml_elements'];

                            $params['order'] = $fields['order'];
                            $params['redirectonempty'] = $fields['redirect_on_empty'];
                            $params['redirectonforbidden'] = $fields['redirect_on_forbidden'];
                            $params['redirectonrequired'] = $fields['redirect_on_required'];
                            $params['requiredparam'] = trim($fields['required_url_param']);
                            $params['negateparam'] = trim($fields['negate_url_param']);
                            $params['paramoutput'] = $fields['param'];
                            $params['sort'] = $fields['sort'];

                            break;
                        case 'navigation':
                            $extends = 'NavigationDatasource';
                            if (isset($fields['filter']['navigation'])) {
                                $filters = $fields['filter']['navigation'];
                            }

                            $params['order'] = $fields['order'];
                            $params['redirectonempty'] = $fields['redirect_on_empty'];
                            $params['redirectonforbidden'] = $fields['redirect_on_forbidden'];
                            $params['redirectonrequired'] = $fields['redirect_on_required'];
                            $params['requiredparam'] = trim($fields['required_url_param']);
                            $params['negateparam'] = trim($fields['negate_url_param']);

                            break;
                        case 'static_xml':
                            $extends = 'StaticXMLDatasource';
                            $fields['static_xml'] = trim($fields['static_xml']);

                            if (preg_match('/^<\?xml/i', $fields['static_xml']) === true) {
                                // Need to remove any XML declaration
                                $fields['static_xml'] = preg_replace('/^<\?xml[^>]+>/i', null, $fields['static_xml']);
                            }

                            $params['static'] = sprintf(
                                '%s',
                                trim($fields['static_xml'])
                            );
                            break;
                        default:
                            $extends = 'SectionDatasource';
                            $elements = $fields['xml_elements'];

                            if (is_array($fields['filter']) && !empty($fields['filter'])) {
                                $filters = array();

                                foreach ($fields['filter'] as $f) {
                                    foreach ($f as $key => $val) {
                                        $filters[$key] = $val;
                                    }
                                }
                            }

                            $params['order'] = $fields['order'];
                            $params['group'] = $fields['group'];
                            $params['paginateresults'] = $fields['paginate_results'];
                            $params['limit'] = $fields['max_records'];
                            $params['startpage'] = $fields['page_number'];
                            $params['redirectonempty'] = $fields['redirect_on_empty'];
                            $params['redirectonforbidden'] = $fields['redirect_on_forbidden'];
                            $params['redirectonrequired'] = $fields['redirect_on_required'];
                            $params['requiredparam'] = trim($fields['required_url_param']);
                            $params['negateparam'] = trim($fields['negate_url_param']);
                            $params['paramoutput'] = $fields['param'];
                            $params['sort'] = $fields['sort'];
                            $params['htmlencode'] = $fields['html_encode'];
                            $params['associatedentrycounts'] = $fields['associated_entry_counts'];

                            break;
                    }

                    $this->__injectVarList($dsShell, $params);
                    $this->__injectIncludedElements($dsShell, $elements);
                    self::injectFilters($dsShell, $filters);

                    if (preg_match_all('@(\$ds-[0-9a-z_\.\-]+)@i', $dsShell, $matches)) {
                        $dependencies = General::array_remove_duplicates($matches[1]);
                        $dsShell = str_replace('<!-- DS DEPENDENCY LIST -->',
                            "'" . implode("', '", $dependencies) . "'", $dsShell);
                    }

                    $dsShell = str_replace('<!-- CLASS EXTENDS -->', $extends, $dsShell);
                    $dsShell = str_replace('<!-- SOURCE -->', $source, $dsShell);
                }

                if ($this->_context['action'] === 'new') {
                    /**
                     * Prior to creating the Datasource, the file path where it will be written to
                     * is provided and well as the contents of that file.
                     *
                     * @delegate DatasourcePreCreate
                     * @since Symphony 2.2
                     * @param string $context
                     * '/blueprints/datasources/'
                     * @param string $file
                     *  The path to the Datasource file
                     * @param string $contents
                     *  The contents for this Datasource as a string passed by reference
                     * @param array $params
                     *  An array of all the `$dsParam*` values
                     * @param array $elements
                     *  An array of all the elements included in this datasource
                     * @param array $filters
                     *  An associative array of all the filters for this datasource with the key
                     *  being the `field_id` and the value the filter.
                     * @param array $dependencies
                     *  An array of dependencies that this datasource has
                     */
                    Symphony::ExtensionManager()->notifyMembers('DatasourcePreCreate', '/blueprints/datasources/',
                        array(
                            'file' => $file,
                            'contents' => &$dsShell,
                            'params' => $params,
                            'elements' => $elements,
                            'filters' => $filters,
                            'dependencies' => $dependencies

The variable $dependencies does not seem to be defined for all execution paths leading up to this point.

                        ));
                } else {
                    /**
                     * Prior to editing a Datasource, the file path where it will be written to
                     * is provided and well as the contents of that file.
                     *
                     * @delegate DatasourcePreEdit
                     * @since Symphony 2.2
                     * @param string $context
                     * '/blueprints/datasources/'
                     * @param string $file
                     *  The path to the Datasource file
                     * @param string $contents
                     *  The contents for this Datasource as a string passed by reference
                     * @param array $dependencies
                     *  An array of dependencies that this datasource has
                     * @param array $params
                     *  An array of all the `$dsParam*` values
                     * @param array $elements
                     *  An array of all the elements included in this datasource
                     * @param array $filters
                     *  An associative array of all the filters for this datasource with the key
                     *  being the `field_id` and the value the filter.
                     */
                    Symphony::ExtensionManager()->notifyMembers('DatasourcePreEdit', '/blueprints/datasources/', array(
                        'file' => $file,
                        'contents' => &$dsShell,
                        'dependencies' => $dependencies,
                        'params' => $params,
                        'elements' => $elements,
                        'filters' => $filters
                    ));
                }

                // Remove left over placeholders
                $dsShell = preg_replace(array('/<!--[\w ]++-->/', '/(\t+[\r\n]){2,}/', '/(\r\n){2,}/'), '$1', $dsShell);

                // Write the file
                if (!is_writable(dirname($file)) || !General::writeFile($file, $dsShell,
                        Symphony::Configuration()->get('write_mode', 'file'), 'w', true)
                ) {
                    $this->pageAlert(
                        __('Failed to write Data source to disk.')
                        . ' ' . __('Please check permissions on %s.', array('<code>/workspace/data-sources</code>')),
                        Alert::ERROR
                    );

                    // Write successful
                } else {
                    if (function_exists('opcache_invalidate')) {
                        opcache_invalidate($file, true);
                    }

                    // Attach this datasources to pages
                    $connections = $fields['connections'];
                    ResourceManager::setPages(ResourceManager::RESOURCE_TYPE_DS,
                        is_null($existing_handle) ? $classname : $existing_handle, $connections);

The variable $existing_handle does not seem to be defined for all execution paths leading up to this point.

                    // If the datasource has been updated and the name changed, then adjust all the existing pages that have the old datasource name
                    if ($queueForDeletion) {

The expression $queueForDeletion of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

                        General::deleteFile($queueForDeletion);

                        // Update pages that use this DS
                        $pages = PageManager::fetch(false, array('data_sources', 'id'), array(
                            "
                        `data_sources` REGEXP '[[:<:]]" . $existing_handle . "[[:>:]]'
                    "
                        ));

                        if (is_array($pages) && !empty($pages)) {
                            foreach ($pages as $page) {
                                $page['data_sources'] = preg_replace('/\b' . $existing_handle . '\b/i', $classname,
                                    $page['data_sources']);

                                PageManager::edit($page['id'], $page);
                            }
                        }
                    }

                    if ($this->_context['action'] === 'new') {
                        /**
                         * After creating the Datasource, the path to the Datasource file is provided
                         *
                         * @delegate DatasourcePostCreate
                         * @since Symphony 2.2
                         * @param string $context
                         * '/blueprints/datasources/'
                         * @param string $file
                         *  The path to the Datasource file
                         */
                        Symphony::ExtensionManager()->notifyMembers('DatasourcePostCreate', '/blueprints/datasources/',
                            array(
                                'file' => $file
                            ));
                    } else {
                        /**
                         * After editing the Datasource, the path to the Datasource file is provided
                         *
                         * @delegate DatasourcePostEdit
                         * @since Symphony 2.2
                         * @param string $context
                         * '/blueprints/datasources/'
                         * @param string $file
                         *  The path to the Datasource file
                         * @param string $previous_file
                         *  The path of the previous Datasource file in the case where a Datasource may
                         *  have been renamed. To get the handle from this value, see
                         *  `DatasourceManager::__getHandleFromFilename`
                         */
                        Symphony::ExtensionManager()->notifyMembers('DatasourcePostEdit', '/blueprints/datasources/',
                            array(
                                'file' => $file,
                                'previous_file' => ($queueForDeletion) ? $queueForDeletion : null
                            ));
                    }

                    redirect(SYMPHONY_URL . '/blueprints/datasources/edit/' . $classname . '/' . ($this->_context['action'] === 'new' ? 'created' : 'saved') . '/');
                }
            }
        }