frappe/frappe/website/sitemap.py

# Copyright (c) 2013, Web Notes Technologies Pvt. Ltd. and Contributors
# MIT License. See license.txt

from __future__ import unicode_literals
import frappe

from frappe.website.utils import scrub_relative_urls, get_home_page, can_cache

def get_sitemap_options(path):
	sitemap_options = None
	cache_key = "sitemap_options:{}".format(path)

	if can_cache():
		sitemap_options = frappe.cache().get_value(cache_key)

	if not sitemap_options:
		sitemap_options = build_sitemap_options(path)
		if can_cache(sitemap_options.no_cache):
			frappe.cache().set_value(cache_key, sitemap_options)

	return frappe._dict(sitemap_options)

def build_sitemap_options(path):
	sitemap_options = frappe._dict(frappe.get_doc("Website Route", path).as_dict())
	home_page = get_home_page()

	if sitemap_options.controller:
		module = frappe.get_module(sitemap_options.controller)

		# get sitemap config fields too
		for prop in ("base_template_path", "template", "no_cache", "no_sitemap",
			"condition_field"):
			if hasattr(module, prop):
				sitemap_options[prop] = getattr(module, prop)

	sitemap_options.doctype = sitemap_options.ref_doctype
	sitemap_options.title = sitemap_options.page_title
	sitemap_options.pathname = sitemap_options.name

	# establish hierarchy
	sitemap_options.parents = frappe.db.sql("""select name, page_title from
		`tabWebsite Route`
		where lft < %s and rgt > %s
		order by lft asc""", (sitemap_options.lft, sitemap_options.rgt), as_dict=True)

	if not sitemap_options.no_sidebar:
		sitemap_options.children = get_route_children(sitemap_options.pathname, home_page)

		if not sitemap_options.children and sitemap_options.parent_website_route \
			and sitemap_options.parent_website_route!=home_page:
			sitemap_options.children = get_route_children(sitemap_options.parent_website_route, home_page)

	# determine templates to be used
	if not sitemap_options.base_template_path:
		app_base = frappe.get_hooks("base_template")
		sitemap_options.base_template_path = app_base[0] if app_base else "templates/base.html"

	return sitemap_options

def get_route_children(pathname, home_page=None):
	if not home_page:
		home_page = get_home_page()

	if pathname==home_page or not pathname:
		children = frappe.db.sql("""select url as name, label as page_title,
			1 as public_read from `tabTop Bar Item` where parentfield='sidebar_items' order by idx""",
			as_dict=True)
	else:
		children = frappe.db.sql("""select * from `tabWebsite Route`
			where ifnull(parent_website_route,'')=%s
			and public_read=1
			order by idx, page_title asc""", pathname, as_dict=True)

		if children:
			# if children are from generator and sort order is specified, then get that condition
			module = frappe.get_module(children[0].controller)
			if hasattr(module, "sort_by"):
				children = frappe.db.sql("""select t1.* from
					`tabWebsite Route` t1, `tab{ref_doctype}` t2
					where ifnull(t1.parent_website_route,'')=%s
					and t1.public_read=1
					and t1.docname = t2.name
					order by {sort_by}""".format(
						ref_doctype = children[0].ref_doctype,
						sort_by = module.sort_by),
						pathname, as_dict=True)

			children = [frappe.get_doc("Website Route", pathname)] + children

	return children

def get_next(route):
	siblings = get_route_children(frappe.db.get_value("Website Route",
		route, "parent_website_route"))
	for i, r in enumerate(siblings):
		if i < len(siblings) - 1:
			if route==r.name:
				return siblings[i+1]