+
+# This program 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 3 of the License, or
+# (at your option) any later version.
+
+# This program 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 this program. If not, see ..
+
+#----------------------------------------------------------------------
+# XMPP: echolib (im@echolib.re)
+#
+# Description: Manage modules creations (metas, to footer called by nginx)
+# File: /var/lib/tyto/program/modules.py
+#----------------------------------------------------------------------
+
+import os, ast, configparser
+import args, domain, langs, tools, debug, form
+
+
+#=================================================#
+# Manage modules creations #
+# metas, header, navbar, sidebar, footer #
+# - User must configure: navbar, sidebar #
+# - Default contents: metas, header, footer #
+# From [module].raw, create [module].html #
+# All are called from file with nginx in web page #
+#-------------------------------------------------#
+def manage(module):
+ global files, wrk_dir, asked, mod_write, wip_dir
+
+ # Set directories
+ wrk_dir = domain.wrk_dirs["modules"]
+ wip_dir = domain.wip_dirs["template"]
+ www_dir = domain.www_dirs["template"]
+
+ debug.out(212, module, wrk_dir, False, 0, False)
+
+ files = {
+ "metas" : {
+ "wrk" : wrk_dir + "metas.raw",
+ "wip" : wip_dir + "metas.html",
+ "www" : www_dir + "metas.html",
+ "set" : set_metas_raw,
+ },
+ "header" : {
+ "wrk" : wrk_dir + "header.raw",
+ "wip" : wip_dir + "header.html",
+ "www" : www_dir + "header.html",
+ "set" : set_header_raw,
+ },
+ "navbar" : {
+ "wrk" : wrk_dir + "navbar.raw",
+ "wip" : wip_dir + "navbar.html",
+ "www" : www_dir + "navbar.html",
+ "set" : set_navbar_raw,
+ },
+ "sidebar" : {
+ "wrk" : wrk_dir + "sidebar.raw",
+ "wip" : wip_dir + "sidebar.html",
+ "www" : www_dir + "sidebar.html",
+ "set" : set_sidebar_raw,
+ },
+ "footer" : {
+ "wrk" : wrk_dir + "footer.raw",
+ "wip" : wip_dir + "footer.html",
+ "www" : www_dir + "footer.html",
+ "set" : set_footer_raw,
+ },
+ }
+
+ # Load/Create new modules in DB file
+ cf_mod_load()
+ mod_write = False
+
+ # Check/Set raw files in modules/
+ for mod in files:
+ # For all modules to reset, confirm once
+ if os.path.exists(files[mod]["wrk"]):
+ if module == "all":
+ try: asked
+ except: form.ask_reset_modules() ; asked = True
+
+ elif mod != module:
+ continue
+
+ mod_write = True
+ files[mod]["set"](mod)
+ tools.create_file(files[mod]["wrk"], files[mod]["usr"])
+ cid = tools.get_HID(files[mod]["wrk"], True)
+ cf_mod_set("RAWS", mod, cid)
+
+ cf_mod_write()
+ if args.action == "new":
+ debug.out(250, module, wrk_dir, True, 0, False)
+
+ # When an article is "wip"
+ # - create html modules
+ # - - if not already exists
+ # - - if raw module has changed
+ if module == "wip":
+ for mod in files:
+ if os.path.exists(files[mod]["wip"]):
+ raw_cid = tools.get_HID(files[mod]["wrk"], True)
+ try: db_id = cf_mod.get("RAWS", mod)
+ except: db_id = ""
+ if raw_cid == db_id:
+ continue
+ else:
+ cf_mod_set("RAWS", mod, raw_cid)
+ mod_write = True
+
+ create_htmls(mod)
+
+ cf_mod_write()
+
+ # When user wants to force update HTML modules
+ # using wip [MODULE] ; called in wip.py
+ elif module == "update":
+ # Create again ALL modules in wip/template
+ if args.commands["modules"]["modules"]:
+ for mod in files:
+ if os.path.exists(files[mod]["wip"]):
+ create_htmls(mod)
+ # Create again specific module from command line
+ else:
+ for mod in args.commands["modules"]:
+ if args.commands["modules"][mod]:
+ if os.path.exists(files[mod]["wip"]):
+ create_htmls(mod)
+
+
+#=======================================#
+# Manage modules configuration ini file #======================================
+#---------------------------------------#
+#================================#
+# Create new modules DB ini file #
+#--------------------------------#
+def cf_mod_load():
+ global cf_mod_uri, cf_mod
+
+ cf_mod_uri = wrk_dir + "modules.ini"
+
+ if not os.path.exists(cf_mod_uri):
+ tools.create_file(cf_mod_uri, "")
+
+ cf_mod = False
+ cf_mod = configparser.ConfigParser()
+ cf_mod.read(cf_mod_uri)
+
+
+#============================#
+# Set datas to cf_mod ini DB #
+#----------------------------#
+def cf_mod_set(section, key, value):
+ global cf_mod
+
+ # Add section if not exists
+ try: cf_mod.add_section(section)
+ except: pass
+
+ cf_mod.set(section, key, value)
+
+
+#==================================#
+# Write to cf_mod ini DB if needed #
+#----------------------------------#
+def cf_mod_write():
+ if mod_write:
+ with open(cf_mod_uri, "w") as f:
+ cf_mod.write(f)
+
+
+#==================================================#
+# Create default raw modules in modules/ directory #===========================
+#--------------------------------------------------#
+#=====================================#
+# Set metas.raw with default contents #
+#-------------------------------------#
+def set_metas_raw(mod):
+ global files
+
+ files["metas"]["usr"] = langs.logs.metas_raw%(
+ domain.conf["title"],
+ domain.wrk_dirs["articles"],
+ files[mod]["wrk"],
+ files[mod]["wip"],
+ files[mod]["www"],
+ ) + metas_raw
+
+
+#======================================#
+# Set header.raw with default contents #
+#--------------------------------------#
+def set_header_raw(mod):
+ global files, header_raw
+
+ # ----------------------------------- #
+ # Fille values for generic header_raw #
+ # ----------------------------------- #
+ header_raw = \
+ header_raw%(
+ "%s %s"%(langs.site.home, domain.conf["title"]),
+ "/template/%s"%domain.cf.get("TEMPLATE_FILENAMES", "logo"),
+ "logo: %s"%domain.conf["title"],
+ domain.conf["title"],
+ domain.conf["about"]
+ )
+
+ files["header"]["usr"] = langs.logs.header_raw%(
+ domain.conf["title"],
+ domain.wrk_dirs["articles"],
+ files[mod]["wrk"],
+ files[mod]["wip"],
+ files[mod]["www"],
+ ) + header_raw
+
+#===============================#
+# Set navbar.raw with help only #
+#-------------------------------#
+def set_navbar_raw(mod):
+ global files
+
+ files["navbar"]["usr"] = langs.logs.metas_raw%(
+ domain.conf["title"],
+ domain.wrk_dirs["articles"],
+ files[mod]["wrk"],
+ files[mod]["wip"],
+ files[mod]["www"],
+ )
+
+
+#================================#
+# Set sidebar.raw with help only #
+#--------------------------------#
+def set_sidebar_raw(mod):
+ global files
+
+ files["sidebar"]["usr"] = langs.logs.sidebar_raw%(
+ domain.conf["title"],
+ domain.wrk_dirs["articles"],
+ files[mod]["wrk"],
+ files[mod]["wip"],
+ files[mod]["www"],
+ )
+
+#======================================#
+# Set footer.raw with default contents #
+#--------------------------------------#
+def set_footer_raw(mod):
+ global files, footer_raw
+
+ # ---------------------------------- #
+ # Fill values for generic footer_raw #
+ # ---------------------------------- "
+ footer_menu = ""
+ footer_link = \
+ '\n'
+
+ for key, value in domain.cf.items("WEBSITE_FOOTER"):
+ try:
+ tupvalues = ast.literal_eval(value)
+ footer_menu = footer_menu + \
+ footer_link%(tupvalues[1], tupvalues[2], "", tupvalues[0])
+ except:
+ debug.out(102, "%s = %s"%(key, value), domain.cf_uri, True, 1, False)
+
+ if domain.conf["sitemaps"]:
+ footer_menu = footer_menu + \
+ footer_link%(
+ "/sitemap.html",
+ langs.site.sitemap, domain.conf["title"],langs.site.sitemap
+ )
+
+ footer_menu = footer_menu + \
+ footer_link%(
+ "/" + domain.cf.get("TEMPLATE_FILENAMES", "rss"),
+ langs.site.feed_rss, domain.conf["title"], langs.site.feed_rss
+ )
+
+ # Copyright link
+ cur_date = tools.nowdate("year")
+ if domain.conf["date"][:4] != cur_date:
+ cur_date = "%s - %s"%(domain.conf["date"][:4], cur_date)
+ footer_copy = "Copyright © %s %s"%(cur_date, domain.conf["title"])
+
+ # Tyto credit links
+ tyto_site_link = "https://tyto.echolib.re/"
+ tyto_code_link = "https://forge.a-lec.org/echolib/tyto-litterateur"
+ footer_tyto = \
+ '%s ['%tyto_code_link + \
+ '%s'%langs.site.source_code + \
+ ']'
+
+ # Create full footer_raw contents
+ footer_raw = footer_raw%(
+ #
+ langs.site.about, domain.conf["title"],
+ # About
+ domain.conf["about"],
+ # Menu list items
+ footer_menu,
+ # Copyright and Tyto credit
+ footer_copy,
+ footer_tyto,
+ )
+
+ files["footer"]["usr"] = langs.logs.footer_raw%(
+ domain.conf["title"],
+ domain.wrk_dirs["articles"],
+ files[mod]["wrk"],
+ files[mod]["wip"],
+ files[mod]["www"],
+ ) + footer_raw
+
+
+#===================================================#
+# Create HTML modules files in template/ wip only #============================
+# At publish process, files are copied, not created #
+#---------------------------------------------------#
+#============================#
+# Create [module].html files #
+#----------------------------#
+def create_htmls(mod):
+ html_file = ""%(mod, mod)
+
+ if mod == "navbar":
+ html_file = create_navbar_html(html_file)
+
+ elif mod == "sidebar":
+ html_file = create_sidebar_html(html_file)
+
+ else:
+ with open(files[mod]["wrk"], "r") as f:
+ for line in f.read().rsplit("\n"):
+ if not line or line.isspace() or line.lstrip().startswith("#"):
+ continue
+
+ html_file = "%s\n%s"%(html_file, line)
+
+ tools.create_file(files[mod]["wip"], html_file)
+ debug.out(250, mod, wip_dir, True, 0, False)
+
+
+#==============================================#
+# Create HTML navbar contents, from navbar.raw #
+#----------------------------------------------#
+def create_navbar_html(html_file):
+ menu_links = ""
+ with open(files["navbar"]["wrk"], "r") as f:
+ for ln, line in enumerate(f.read().rsplit("\n"), 1):
+ line = line.lstrip()
+ if not line or line.isspace() or line.startswith("#"):
+ continue
+
+ # Item has a "title" set with # as separator
+ set_dir = line.rstrip()
+
+
+ # Set_dir begins with "/" ; apply correction
+ if set_dir.startswith("/"): set_dir = set_dir[1:]
+ if set_dir.endswith("/"): set_dir = set_dir[:-1]
+ if not set_dir: # No home / in navbar menu
+ continue
+
+ dir_uri = domain.wrk_dirs["articles"] + set_dir
+
+ # Set_dir must exists
+ if not os.path.exists(dir_uri) or \
+ not os.path.isdir(dir_uri):
+ debug.out(6, "%s. navbar '%s'"%(
+ ln, set_dir
+ ), files["navbar"]["wrk"], True, 1, False)
+ continue
+
+ # Check for index.tyto, load DB if exists, get title
+ if cf_load(ln, set_dir + "/index.tyto", "navbar"):
+ try: set_title = cf.get("ARTICLE", "title")
+ except: continue
+
+ # Check and inform if not index.html exists
+ srv_index_html = domain.wip + "/index.html"
+ if not os.path.exists(srv_index_html):
+ debug.out(11, "%s. navbar (404) wip/%s/index.html"%(
+ ln, set_dir
+ ), files["navbar"]["wrk"], True, 1, False)
+
+ # Create menu links
+ if not menu_links:
+ menu_links = navbar_link%(
+ "/" + set_dir, set_title, os.path.basename(set_dir)
+ )
+ else:
+ menu_links = "%s\n%s"%(
+ menu_links,
+ navbar_link%(
+ "/" + set_dir, set_title, os.path.basename(set_dir)
+ )
+ )
+
+ if menu_links:
+ html_file = html_file + navbar_html%menu_links
+
+ return html_file
+
+
+#================================================#
+# Create HTML sidebar contents, from sidebar.raw #
+#------------------------------------------------#
+def create_sidebar_html(html_file):
+ # Set from config file max links. Return if 0
+ max_items = int(domain.cf.get("WEBSITE_MODULES", "sidebar_items"))
+ sidebar_title = domain.cf.get("WEBSITE_MODULES", "sidebar_title")
+ if max_items == 0:
+ return html_file
+
+ html_items = ""
+ items = 0
+ with open(files["sidebar"]["wrk"], "r") as f:
+ for ln, line in enumerate(f.read().rsplit("\n"), 1):
+ if items == max_items:
+ break
+
+ line = line.lstrip()
+ if not line or \
+ line.isspace() or \
+ line.startswith("#") or \
+ not line.endswith(".tyto"):
+ continue
+
+ # Target begins with "/"... Remove it
+ if line.startswith("/"): line = line[1:]
+
+ # check/load article files
+ if not cf_load(ln, line, "sidebar"):
+ continue
+
+ items += 1
+ print("> -",items, cf.get("ARTICLE", "title"))
+
+ if not html_items:
+ html_items = sidebar_item%(
+ #
+ cf.get("URIS", "web"),
+ cf.get("ARTICLE", "title"),
+ #
+ cf.get("ARTICLE", "title"),
+ cf.get("ARTICLE", "authors"),
+ cf.get("ARTICLE", "local_date"),
+ # Show about
+ cf.get("ARTICLE", "about")
+ )
+ else:
+ html_items = "%s\n%s"%(html_items, sidebar_item%(
+ cf.get("ARTICLE", "title"),
+ cf.get("ARTICLE", "about")
+ )
+ )
+
+ if html_items:
+ html_file = html_file + sidebar_html%(sidebar_title, html_items)
+
+ return html_file
+
+
+#==========================================#
+# Get DB post from URI, and load if exists #
+#------------------------------------------#
+def cf_load(ln, line, modname):
+ global cf
+
+ uri = domain.wrk_dirs["articles"] + line
+ if not os.path.exists(uri):
+ debug.out(11, "%s. %s '%s'"%(
+ ln, modname, line
+ ), files[modname]["wrk"], True, 1, False)
+ return False
+
+ db_uri = domain.wrk_dirs["db"] + tools.get_HID(uri, False) + ".ini"
+ if not os.path.exists(db_uri):
+ debug.out(12, "%s. %s '%s'"%(
+ ln, modname, line
+ ), files[modname]["wrk"], True, 1, False)
+ return False
+
+ cf = configparser.ConfigParser()
+ cf.read(db_uri)
+
+ try: srv_uri = cf.get("URIS", "wip")
+ except: srv_uri = ""
+ if not srv_uri or not os.path.exists(srv_uri):
+ debug.out(13, "%s. %s '%s'"%(
+ ln, modname, line
+ ), files[modname]["wrk"], True, 1, False)
+ return False
+
+ return True
+
+
+#===============#
+# MAIN settings #==============================================================
+#---------------#
+# ---------------------------- #
+# Default raw modules contents #
+# ---------------------------- #
+#-------#
+# Metas #
+#-------#
+metas_raw = """
+
+
+
+
+
+"""
+
+#--------#
+# Header #
+#--------#
+header_raw = """
+
+