PageEditPage::save() - Code Metrics - Inspection of "fixed some problems in class PageEditPage, see iss..." - JuKu/JuKuCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 6b7dd4...0b91cf )

by Justin
created 2018-09-18 13:24 UTC
PageEditPage::save() F

↳ Parent: PageEditPage
Complexity

Conditions	32
Paths	149
Size

Total Lines	128
Code Lines	66
Duplication

Lines	0
Ratio	0 %
Importance

Changes	14
Bugs	3	Features	6
Metric	Value
cc	32
eloc	66
c	14
b	3
f	6
nc	149
nop	1
dl	0
loc	128
rs	3.7583
How to fix Long Method Complexity

<?php

/**
 * Copyright (c) 2018 Justin Kuenzel (jukusoft.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


/**
 * Project: RocketCMS
 * License: Apache 2.0 license
 * User: Justin
 * Date: 03.09.2018
 * Time: 14:36
 */

class PageEditPage extends PageType {

	protected $sitemap_change_frequencies = array(
		"AlWAYS", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "NEVER"
	);

	public function getContent(): string {
		$template = new DwooTemplate("pages/editpage");

		//check, if pageID is set
		if (!isset($_REQUEST['edit']) || empty($_REQUEST['edit'])) {
			//show error
			return $this->showError("No pageID was set!");
		}

		$pageID = (int) $_REQUEST['edit'];

		$page = new Page();
		$page->loadByID($pageID);

		//first check permissions
		if (!PermissionChecker::current()->hasRight("can_edit_all_pages") && !(PermissionChecker::current()->hasRight("can_edit_own_pages") && $page->getAuthorID() == User::current()->getID())) {
			//user doesn't have permissions to edit this page
			return $this->showError("You don't have permissions to edit this page!");
		}

		//first, lock page
		Page::lockPage($page->getPageID(), User::current()->getID());

		$success_messages = array();
		$error_messages = array();

		//save page
		if (isset($_REQUEST['submit'])) {
			if ($_REQUEST['submit'] === "Save") {
				//save page
				$res = $this->save($page);

				if ($res === true) {
					$success_messages[] = "Saved page successfully!";
				} else {
					$error_messages[] = $res;
				}
			} else if ($_REQUEST['submit'] === "SaveUnlock") {
				//save page
				$res = $this->save($page);

				if ($res === true) {
					//unlock page
					Page::unlockPage($page->getPageID());

					//redirect to admin/pages
					header("Location: " . DomainUtils::generateURL("admin/pages"));

					ob_flush();
					ob_end_flush();

					exit;
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
				} else {
					$error_messages[] = $res;
				}
			} else if ($_REQUEST['submit'] === "Publish") {
				//save page
				$res = $this->save($page);

				if ($res === true) {
					$success_messages[] = "Saved page successfully!";
				} else {
					$error_messages[] = $res;
				}

				//publish page
				$res = $this->publish($page);

				if ($res === true) {
					$success_messages[] = "Page published successfully!";
				} else {
					$error_messages[] = $res;
				}
			}
		}

		$template->assign("action_url", DomainUtils::generateURL($this->getPage()->getAlias(), array("edit" => $pageID)));

		$template->assign("page", array(
			'id' => $page->getPageID(),
			'alias' => "/" . $page->getAlias(),
			'title' => $page->getTitle(),
			'content' => $page->getContent(),
			'is_published' => $page->isPublished(),
			'can_publish' => (!$page->isPublished() && (PermissionChecker::current()->hasRight("can_publish_all_pages") || (PermissionChecker::current()->hasRight("can_publish_own_pages") && $page->getAuthorID() == User::current()->getID()))),
			'can_change_owner' => (PermissionChecker::current()->hasRight("can_change_page_owner") || $page->getAuthorID() == User::current()->getID()),
			'folder' => $page->getFolder(),
			'preview_url' => DomainUtils::generateURL($page->getAlias(), array("preview" => "true")),
			'current_style' => $page->getStyle(),
			'template' => $page->getCustomTemplate(),
			'has_custom_template' => $page->hasCustomTemplate(),
			'parent' => $page->getParentID(),
			'meta_description' => $page->getMetaDescription(),
			'meta_keywords' => $page->getMetaKeywords(),
			'meta_robots' => $page->getMetaRobotsOptions(),
			'meta_canonicals' => $page->getMetaCanonicals(),
			'has_canoncials' => !empty($page->getMetaCanonicals()),
			'sitemap' => $page->isSitemapEnabled(),
			'sitemap_changefreq' => $page->getSitemapChangeFreq(),
			'sitemap_priority' => $page->getSitemapPriority(),
			'og_type' => $page->getOgType()
		));

		//set available styles
		$template->assign("styles", StyleController::listAllStyles());

		//get all pages from database
		$pages = array();
		$rows = Database::getInstance()->listRows("SELECT `id`, `alias` FROM `{praefix}pages` WHERE `editable` = '1' AND `activated` = '1'; ");

		foreach ($rows as $row) {
			$pages[] = array(
				'id' => $row['id'],
				'alias' => $row['alias']
			);
		}

		$template->assign("parent_pages", $pages);

		//https://developers.google.com/search/reference/robots_meta_tag?hl=de
		$robots_options = array(
			"all",
			"noindex",
			"nofollow",
			"none",
			"noarchive",
			"nosnippet",
			"noodp",
			"notranslate",
			"noimageindex",
			"unavailable_after: "
		);

		$template->assign("robots_options", $robots_options);

		$sitemap_change_frequencies = $this->sitemap_change_frequencies;

		$template->assign("sitemap_change_frequencies", $sitemap_change_frequencies);

		//OpenGraph types,https://developers.facebook.com/docs/reference/opengraph/
		$og_types = array("website", "article", "book", "profile");

		$template->assign("og_types", $og_types);

		//add support to show additional code from plugins
		$additional_code_header = "";
		$additional_code_footer = "";

		Events::throwEvent("page_edit_additional_code_header", array(
			'page' => &$page,
			'code' => &$additional_code_header
		));

		$template->assign("additional_code_header", $additional_code_footer);

		Events::throwEvent("page_edit_additional_code_footer", array(
			'page' => &$page,
			'code' => &$additional_code_footer
		));

		$template->assign("additional_code_footer", $additional_code_footer);

		$template->assign("errors", $error_messages);
		$template->assign("success_messages", $success_messages);

		return $template->getCode();
	}

	protected function save (Page &$page) {
		//first check permissions
		if (!PermissionChecker::current()->hasRight("can_edit_all_pages") && !(PermissionChecker::current()->hasRight("can_edit_own_pages") && $page->getAuthorID() == User::current()->getID())) {
			//user doesn't have permissions to edit this page
			return "You don't have permissions to edit this page!";
		}

		if (!isset($_POST['title']) || empty($_POST['title'])) {
			return "No title was set";
		}

		//validate title
		$title = htmlentities($_POST['title']);

		if (!isset($_POST['html_code']) || empty($_POST['html_code'])) {
			return "No content was set or content is empty!";
		}

		$content = $_POST['html_code'];

		//TODO: save page attributes
		if (!isset($_REQUEST['parent']) || empty($_REQUEST['parent'])) {
			return "Parent page wasn't set!";
		}

		$parent = (int) $_REQUEST['parent'];

		if (!isset($_REQUEST['design']) || empty($_REQUEST['design'])) {
			return "Design wasn't set!";
		}

		$design = $_REQUEST['design'];

		//TODO: check, if style (design) exists

		$template = "none";

		if (isset($_REQUEST['has_custom_template']) && isset($_REQUEST['template']) && !empty($_REQUEST['template'])) {
			$template = $_REQUEST['template'];
		}

		$keywords = "";

		if (!isset($_REQUEST['meta_keywords']) || empty($_REQUEST['meta_keywords'])) {
			//return "Meta keywords wasn't set!";
		} else {
			$keywords = htmlentities($_REQUEST['meta_keywords']);
		}

		$robots = "";

		if (!isset($_REQUEST['meta_robots']) || empty($_REQUEST['meta_robots'])) {
			//return "Meta robots wasn't set!";
		} else {
			$robots = htmlentities($_REQUEST['meta_robots']);
		}

		$canoncials = "";

		if (isset($_REQUEST['has_canoncials']) && isset($_REQUEST['meta_canoncials']) && !empty($_REQUEST['meta_canoncials'])) {
			$canoncials = $_REQUEST['meta_canoncials'];
		}

		$sitemap = 0;
		$sitemap_changefreq = "WEEKLY";
		$sitemap_priority = 0.5;

		if (isset($_REQUEST['sitemap'])) {
			$sitemap = 1;

			if (!isset($_REQUEST['sitemap_changefreq']) || empty($_REQUEST['sitemap_changefreq'])) {
				return "Sitemap change frequency wasn't set!";
			}

			$sitemap_changefreq = $_REQUEST['sitemap_changefreq'];

			if (!in_array($sitemap_changefreq, $this->sitemap_change_frequencies)) {
				return "Invalide value for sitemap change frequency: " . $sitemap_changefreq;
			}

			if (!isset($_REQUEST['sitemap_priority']) || empty($_REQUEST['sitemap_priority'])) {
				return "Sitemap priority wasn't set!";
			}

			$sitemap_priority = (float) $_REQUEST['sitemap_priority'];

			if ($sitemap_priority < 0) {
				return "Minimum value of sitemap priority is 0.";
			}

			if ($sitemap_priority > 1) {
				return "Maximum value of sitemap priority is 1.";
			}
		}

		if (!isset($_REQUEST['og_type']) || empty($_REQUEST['og_type'])) {
			return "OpenGraph type wasn't set!";
		}

		$og_type = $_REQUEST['og_type'];

		//update page in database
		Database::getInstance()->execute("UPDATE `{praefix}pages` SET `title` = :title, `content` = :content, `parent` = :parent, `design` = :design, `template` = :template, `sitemap` = :sitemap, `sitemap_changefreq` = :sitemap_changefreq, `sitemap_priority` = :sitemap_priority, `meta_keywords` = :keywords, `meta_robots` = :robots, `meta_canonicals` = :canoncials, `og_type` = :og_type WHERE `id` = :pageID; ", array(
			'title' => $title,
			'content' => $content,
			'pageID' => $page->getPageID(),
			'parent' => $parent,
			'design' => $design,
			'template' => $template,
			'sitemap' => $sitemap,
			'sitemap_changefreq' => $sitemap_changefreq,
			'sitemap_priority' => $sitemap_priority,
			'keywords' => $keywords,
			'robots' => $robots,
			'canoncials' => $canoncials,
			'og_type' => $og_type
		));

		//clear cache
		$page->clearCache();

		//reload page from database
		$page->loadByID($page->getPageID(), false);

		//TODO: remove this line later
		Cache::clear("pages");

		return true;
	}

	protected function publish (Page &$page) {
		//check permissions for publishing
		if (PermissionChecker::current()->hasRight("can_publish_all_pages") || (PermissionChecker::current()->hasRight("can_publish_own_pages") && $page->getAuthorID() == User::current()->getID())) {
			//update page in database
			Database::getInstance()->execute("UPDATE `{praefix}pages` SET `published` = '1' WHERE `id` = :pageID; ", array(
				'pageID' => $page->getPageID()
			));

			//clear cache
			$page->clearCache();

			//reload page from database
			$page->loadByID($page->getPageID(), false);

			//TODO: remove this line later
			Cache::clear("pages");

			return true;
		} else {
			return "You don't have the permissions to publish this page!";
		}
	}

	protected function showError (string $message) : string {
	protected function showError (/** @scrutinizer ignore-unused */ string $message) : string {
		//show error
		$template = new DwooTemplate("pages/error");
		$template->assign("message", "No pageID was set!");
		return $template->getCode();
	}

	public function getFooterScripts(): string {
		$style_name = Registry::singleton()->getSetting("current_style_name");
		$style_path = DomainUtils::getBaseURL() . "/styles/" . $style_name . "/";


		$thirdparty_url = Registry::singleton()->getSetting("thirdparty_url");

		/*return "<!-- CK Editor -->
			<script src=\"" . $style_path . "bower_components/ckeditor/ckeditor.js\"></script>
			
			<script>
				$(function () {
					// Replace the <textarea id=\"editor1\"> with a CKEditor
					// instance, using default configuration.
					CKEDITOR.replace('wysiwygEditor', {
						height: '500px',
						enterMode: CKEDITOR.ENTER_BR
					});
				});
			</script>";*/

		return "<script src=\"" . $thirdparty_url . "tinymce_4.8.2/js/tinymce/tinymce.min.js\"></script>
  				<script>tinymce.init({
					  selector: 'textarea',
					  height: 500,
					  theme: 'modern',
					  removed_menuitems: 'newdocument',
					  plugins: 'print preview searchreplace autolink directionality visualblocks visualchars fullscreen image link media template codesample table charmap hr pagebreak nonbreaking anchor toc insertdatetime advlist lists textcolor wordcount imagetools contextmenu colorpicker textpattern help',
					  toolbar1: 'formatselect | bold italic strikethrough forecolor backcolor | link | alignleft aligncenter alignright alignjustify  | numlist bullist outdent indent  | removeformat',
					  image_advtab: true
				});
				
				document.getElementById('customTplCheckbox').onchange = function() {
					document.getElementById('inputTpl').disabled = !this.checked;
					
					if (!this.checked) {
						document.getElementById('inputTpl').value = 'none';
					}
				};
				
				document.getElementById('customCanoncialsCheckbox').onchange = function() {
					document.getElementById('inputCanoncials').disabled = !this.checked;
					
					if (!this.checked) {
						document.getElementById('inputCanoncials').value = '';
					}
				};
				
				document.getElementById('inputSitemap').onchange = function() {
					document.getElementById('inputSitemapChangeFrequency').disabled = !this.checked;
					document.getElementById('inputSitemapPriority').disabled = !this.checked;
				};
				</script>";
	}

	public function listRequiredPermissions(): array {
		return array("can_edit_all_pages", "can_edit_own_pages");
	}

}

?>


JuKu / JuKuCMS

Push — master ( 6b7dd4...0b91cf )

PageEditPage::save() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
