#!/usr/bin/env python3 # encoding: utf-8 import html import glob import os import re import sys import time import urllib.parse from subprocess import Popen from unit_tree.team_colorizer import colorize # # HTML template bits # # HTML assets that need to be copied to the destination dir. HTML_RESOURCES = ( "style.css", "jquery.js", "tablesorter.js", "asc.gif", "bg.gif", "desc.gif" # Used by style.css: ) WESMERE_CSS_VERSION = "1.2.0" WESMERE_CSS_PREFIX = "https://www.wesnoth.org" WESMERE_HEADER = '''\ Wesnoth %(server_name)s Add-ons List - The Battle for Wesnoth

Wesnoth %(server_name)s Add-ons List

To install add-ons using the in-game client, choose “Add-ons” from the main menu, and click “Connect” to connect to the add-ons server. Pick the add-on you want to install from the list and click the “+” icon — the download will commence immediately and the add-on will be automatically installed once finished. Bear in mind that not all add-ons are singleplayer campaigns!

''' WESMERE_DOWNLOAD_HELP = '''\

If you really need or would prefer to download add-ons from this web page instead of using the built-in client, use a compatible program to uncompress the full contents of the tar.bz2 file — including the subfolder named after the add-on — to the data/add-ons/ folder in your game’s user data folder. The add-on will be recognized next time you launch Wesnoth or press F5 on the main menu.

Tip: Hover over the type field to see an explanation of the add-on type and over an icon to see a description for the add-on.

''' WESMERE_FOOTER = '''\
''' ADDON_TYPES_INFO = { "scenario": { "short": "Scenario", "long": "Singleplayer scenario", "help": "After install the scenario will show up in the list you get when choosing “Campaign” in the main menu. (Basically it is just a campaign with only one scenario.)", }, "campaign": { "short": "Campaign", "long": "Singleplayer campaign", "help": "After install the campaign will show up in the list you get when choosing “Campaign” in the main menu.", }, "campaign_sp_mp": { "short": "SP/MP Campaign", "long": "Single/multiplayer campaign", "help": "After install the campaign will show up both in the list you get when choosing “Campaign” in the main menu, and in the map list in the multiplayer “Create Game” dialog.", }, "campaign_mp": { "short": "MP Campaign", "long": "Multiplayer campaign", "help": "After install the first scenario of the campaign will be available in the map list in the multiplayer “Create Game” dialog.", }, "scenario_mp": { "short": "MP Scenario", "long": "Multiplayer scenario", "help": "After install the scenario will be available in the map list in the multiplayer “Create Game” dialog.", }, "map_pack": { "short": "MP Map Pack", "long": "Multiplayer map pack", "help": "After install the maps/scenarios will be available in the map list in the multiplayer “Create Game” dialog.", }, "era": { "short": "MP Era", "long": "Multiplayer era", "help": "After install the included era(s) will be available in the multiplayer “Create Game” dialog.", }, "faction": { "short": "MP Faction", "long": "Multiplayer faction", "help": "Usually comes with an era or is a dependency of another add-on.", }, "mod_mp": { "short": "Modification", "long": "Modification", "help": "After install the included gameplay modification(s) will be available when choosing “Campaign” in the main menu, and in the multiplayer “Create Game” dialog.", }, "media": { "short": "Resources", "long": "Miscellaneous content/media", "help": "Unit packs, terrain packs, music packs, etc. Usually a (perhaps optional) dependency of another add-on.", }, "core": { "short": "Core", "long": "Core/Total Conversion", "help": "Cores enable total conversion of The Battle for Wesnoth. A core can replace all the content in Wesnoth: when a different core is loaded, the regular units, terrains and the like do not exist. This can be used to provide a completely different game experience.", }, "other": { "short": "Other", "long": "Other", "help": "Add-ons which do not fit any other category.", }, "unknown": { "short": "Unknown", "long": "Unknown Add-on Type", "help": "Add-ons with an invalid add-on type field.", }, } def htmlescape(text, quote=True): """Escape any HTML special characters in the given string.""" if text is None: return text return html.escape(text, quote) def urlencode(text): """ Encode the given string to ensure it only contains valid URL characters (also known as percent-encoding). """ if text is None: return text return urllib.parse.quote(text, encoding='utf-8') def output(path, url, datadir, data): """Write the HTML index of add-ons into the specified directory.""" try: os.mkdir(path) except OSError: pass outfile = open(path + "/index.html", "w") def w(line): outfile.write(line + "\n") am_dir = os.path.dirname(__file__) + "/" root_dir = datadir + "/" if datadir is not None else am_dir + "../../../" images_to_tc = [] # Copy required HTML assets into the destination dir. for filename in HTML_RESOURCES: Popen(["cp", "-u", am_dir + filename, path]) server_name = os.path.basename(path) if server_name == "1.9": # 1.9 became the 1.10 add-ons server. Reflect that here. server_name = "1.10" elif server_name == "trunk": server_name = "Testing (Trunk)" w(WESMERE_HEADER % { "css_version": WESMERE_CSS_VERSION, "css_prefix": WESMERE_CSS_PREFIX, "server_name": server_name, }) if url: w(WESMERE_DOWNLOAD_HELP) w('\n\n') table_headers = [ ("type", "Type"), ("icon", "Icon"), ("name", "Addon"), ("size", "Size"), ("stats", "Traffic"), ("date", "Date"), ("locales", "Translations") ] for header_class, header_label in table_headers: w('' % (header_class, header_label)) w('\n\n') addons = data.get_all(tag="campaigns")[0] for addon in addons.get_all(tag="campaign"): v = addon.get_text_val addon_id = v("name") # Escaped as part of a path composition later on. title = htmlescape(v("title", "unknown")) size = float(v("size", "0")) # bytes display_size = size / (1024 * 1024) # MiB addon_type = htmlescape(v("type", "none")) version = htmlescape(v("version", "unknown")) author = htmlescape(v("author", "unknown")) feedback_url = v("feedback_url", None) # Escaped by a function call. icon = htmlescape(v("icon", "")) description = htmlescape(v('description', '(no description)')) imgurl = "" downloads = int(v("downloads", "0")) uploads = int(v("uploads", "0")) timestamp = int(v("timestamp", "0")) display_ts = time.strftime("%b %d %Y", time.localtime(timestamp)) translations = addon.get_all(tag="translation") languages = [x.get_text_val("language") for x in translations] if icon: icon = icon.strip() uri_manifest = re.match('^data:(image/(?:png|jpeg));base64,', icon) if uri_manifest: if uri_manifest.group(1) not in ('image/png', 'image/jpeg'): sys.stderr.write("Data URI icon using unsupported content type " + uri_manifest.group(1)) else: imgurl = icon else: tilde = icon.find("~") if tilde >= 0: icon = icon[:tilde] if "\\" in icon: icon = icon.replace("\\", "/") try: os.mkdir(path + "/icons") except OSError: pass if "." not in icon: icon += ".png" src = root_dir + icon imgurl = "icons/" + os.path.basename(icon) if not os.path.exists(src): src = root_dir + "data/core/images/" + icon if not os.path.exists(src): src = root_dir + "images/" + icon if not os.path.exists(src): src = glob.glob(root_dir + "data/campaigns/*/images/" + icon) if src: src = src[0] if not src or not os.path.exists(src): sys.stderr.write("Cannot find icon " + icon + "\n") src = root_dir + "images/misc/missing-image.png" imgurl = "icons/missing-image.png" images_to_tc.append((src, path + "/" + imgurl)) w('') w('') w(('') % ( imgurl, title, description)) def make_icon_button(url, label, icon): w(('' '' '{1}').format( htmlescape(url), htmlescape(label), icon)) w('') % ( title, version, author)) w("" % (size, display_size)) w("" % (downloads, uploads)) w('' % (timestamp, display_ts)) w("" % htmlescape(", ".join(languages), quote=False)) w("") w('\n
%s   
') if addon_type in ADDON_TYPES_INFO: w('%(short)s
%(long)s
%(help)s
' \ % ADDON_TYPES_INFO[addon_type]) else: w(addon_type) w('		' '
%s
%s
' % title) if url or feedback_url: w('') if feedback_url: make_icon_button(feedback_url, "Forum topic", "comment") if url: link = url.rstrip("/") + "/" + urlencode(addon_id) + ".tar.bz2" make_icon_button(link, "Download", "download") w('') w(('%s
' 'Version: %s
' 'Author: %s		%.2f MiB%d down
%s up		%s%s
') w(WESMERE_FOOTER) sys.stderr.write("Done outputting html, now generating %d TC'ed images\n" % len(images_to_tc)) for pair in images_to_tc: colorize(None, pair[0], pair[1]) # kate: indent-mode normal; encoding utf-8; space-indent on;