diff --git a/.github/workflows/luacheck.yml b/.github/workflows/luacheck.yml new file mode 100644 index 0000000..b501650 --- /dev/null +++ b/.github/workflows/luacheck.yml @@ -0,0 +1,10 @@ +name: luacheck +on: [push, pull_request] +jobs: + luacheck: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + - name: Luacheck + uses: lunarmodules/luacheck@master \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 6fd0a37..0000000 --- a/.gitignore +++ /dev/null @@ -1,41 +0,0 @@ -# Compiled Lua sources -luac.out - -# luarocks build files -*.src.rock -*.zip -*.tar.gz - -# Object files -*.o -*.os -*.ko -*.obj -*.elf - -# Precompiled Headers -*.gch -*.pch - -# Libraries -*.lib -*.a -*.la -*.lo -*.def -*.exp - -# Shared objects (inc. Windows DLLs) -*.dll -*.so -*.so.* -*.dylib - -# Executables -*.exe -*.out -*.app -*.i*86 -*.x86_64 -*.hex - diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..40425a5 --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,6 @@ +unused_args = false + +read_globals = { + "minetest", + "ItemStack" +} \ No newline at end of file diff --git a/i18n.py b/i18n.py deleted file mode 100644 index dd901e9..0000000 --- a/i18n.py +++ /dev/null @@ -1,421 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# Script to generate the template file and update the translation files. -# Copy the script into the mod or modpack root folder and run it there. -# -# Copyright (C) 2019 Joachim Stolberg, 2020 FaceDeer, 2020 Louis Royer -# LGPLv2.1+ -# -# See https://github.com/minetest-tools/update_translations for -# potential future updates to this script. - -from __future__ import print_function -import os, fnmatch, re, shutil, errno -from sys import argv as _argv - -# Running params -params = {"recursive": False, - "help": False, - "mods": False, - "verbose": False, - "folders": [] -} -# Available CLI options -options = {"recursive": ['--recursive', '-r'], - "help": ['--help', '-h'], - "mods": ['--installed-mods'], - "verbose": ['--verbose', '-v'] -} - -# Strings longer than this will have extra space added between -# them in the translation files to make it easier to distinguish their -# beginnings and endings at a glance -doublespace_threshold = 60 - -def set_params_folders(tab: list): - '''Initialize params["folders"] from CLI arguments.''' - # Discarding argument 0 (tool name) - for param in tab[1:]: - stop_param = False - for option in options: - if param in options[option]: - stop_param = True - break - if not stop_param: - params["folders"].append(os.path.abspath(param)) - -def set_params(tab: list): - '''Initialize params from CLI arguments.''' - for option in options: - for option_name in options[option]: - if option_name in tab: - params[option] = True - break - -def print_help(name): - '''Prints some help message.''' - print(f'''SYNOPSIS - {name} [OPTIONS] [PATHS...] -DESCRIPTION - {', '.join(options["help"])} - prints this help message - {', '.join(options["recursive"])} - run on all subfolders of paths given - {', '.join(options["mods"])} - run on locally installed modules - {', '.join(options["verbose"])} - add output information -''') - - -def main(): - '''Main function''' - set_params(_argv) - set_params_folders(_argv) - if params["help"]: - print_help(_argv[0]) - elif params["recursive"] and params["mods"]: - print("Option --installed-mods is incompatible with --recursive") - else: - # Add recursivity message - print("Running ", end='') - if params["recursive"]: - print("recursively ", end='') - # Running - if params["mods"]: - print(f"on all locally installed modules in {os.path.abspath('~/.minetest/mods/')}") - run_all_subfolders("~/.minetest/mods") - elif len(params["folders"]) >= 2: - print("on folder list:", params["folders"]) - for f in params["folders"]: - if params["recursive"]: - run_all_subfolders(f) - else: - update_folder(f) - elif len(params["folders"]) == 1: - print("on folder", params["folders"][0]) - if params["recursive"]: - run_all_subfolders(params["folders"][0]) - else: - update_folder(params["folders"][0]) - else: - print("on folder", os.path.abspath("./")) - if params["recursive"]: - run_all_subfolders(os.path.abspath("./")) - else: - update_folder(os.path.abspath("./")) - -#group 2 will be the string, groups 1 and 3 will be the delimiters (" or ') -#See https://stackoverflow.com/questions/46967465/regex-match-text-in-either-single-or-double-quote -pattern_lua = re.compile(r'[\.=^\t,{\(\s]N?S\(\s*(["\'])((?:\\\1|(?:(?!\1)).)*)(\1)[\s,\)]', re.DOTALL) -pattern_lua_bracketed = re.compile(r'[\.=^\t,{\(\s]N?S\(\s*\[\[(.*?)\]\][\s,\)]', re.DOTALL) - -# Handles "concatenation" .. " of strings" -pattern_concat = re.compile(r'["\'][\s]*\.\.[\s]*["\']', re.DOTALL) - -pattern_tr = re.compile(r'(.+?[^@])=(.*)') -pattern_name = re.compile(r'^name[ ]*=[ ]*([^ \n]*)') -pattern_tr_filename = re.compile(r'\.tr$') -pattern_po_language_code = re.compile(r'(.*)\.po$') - -#attempt to read the mod's name from the mod.conf file. Returns None on failure -def get_modname(folder): - try: - with open(os.path.join(folder, "mod.conf"), "r", encoding='utf-8') as mod_conf: - for line in mod_conf: - match = pattern_name.match(line) - if match: - return match.group(1) - except FileNotFoundError: - pass - return None - -#If there are already .tr files in /locale, returns a list of their names -def get_existing_tr_files(folder): - out = [] - for root, dirs, files in os.walk(os.path.join(folder, 'locale/')): - for name in files: - if pattern_tr_filename.search(name): - out.append(name) - return out - -# A series of search and replaces that massage a .po file's contents into -# a .tr file's equivalent -def process_po_file(text): - # The first three items are for unused matches - text = re.sub(r'#~ msgid "', "", text) - text = re.sub(r'"\n#~ msgstr ""\n"', "=", text) - text = re.sub(r'"\n#~ msgstr "', "=", text) - # comment lines - text = re.sub(r'#.*\n', "", text) - # converting msg pairs into "=" pairs - text = re.sub(r'msgid "', "", text) - text = re.sub(r'"\nmsgstr ""\n"', "=", text) - text = re.sub(r'"\nmsgstr "', "=", text) - # various line breaks and escape codes - text = re.sub(r'"\n"', "", text) - text = re.sub(r'"\n', "\n", text) - text = re.sub(r'\\"', '"', text) - text = re.sub(r'\\n', '@n', text) - # remove header text - text = re.sub(r'=Project-Id-Version:.*\n', "", text) - # remove double-spaced lines - text = re.sub(r'\n\n', '\n', text) - return text - -# Go through existing .po files and, if a .tr file for that language -# *doesn't* exist, convert it and create it. -# The .tr file that results will subsequently be reprocessed so -# any "no longer used" strings will be preserved. -# Note that "fuzzy" tags will be lost in this process. -def process_po_files(folder, modname): - for root, dirs, files in os.walk(os.path.join(folder, 'locale/')): - for name in files: - code_match = pattern_po_language_code.match(name) - if code_match == None: - continue - language_code = code_match.group(1) - tr_name = modname + "." + language_code + ".tr" - tr_file = os.path.join(root, tr_name) - if os.path.exists(tr_file): - if params["verbose"]: - print(f"{tr_name} already exists, ignoring {name}") - continue - fname = os.path.join(root, name) - with open(fname, "r", encoding='utf-8') as po_file: - if params["verbose"]: - print(f"Importing translations from {name}") - text = process_po_file(po_file.read()) - with open(tr_file, "wt", encoding='utf-8') as tr_out: - tr_out.write(text) - -# from https://stackoverflow.com/questions/600268/mkdir-p-functionality-in-python/600612#600612 -# Creates a directory if it doesn't exist, silently does -# nothing if it already exists -def mkdir_p(path): - try: - os.makedirs(path) - except OSError as exc: # Python >2.5 - if exc.errno == errno.EEXIST and os.path.isdir(path): - pass - else: raise - -# Converts the template dictionary to a text to be written as a file -# dKeyStrings is a dictionary of localized string to source file sets -# dOld is a dictionary of existing translations and comments from -# the previous version of this text -def strings_to_text(dkeyStrings, dOld, mod_name): - lOut = [f"# textdomain: {mod_name}\n"] - - dGroupedBySource = {} - - for key in dkeyStrings: - sourceList = list(dkeyStrings[key]) - sourceList.sort() - sourceString = "\n".join(sourceList) - listForSource = dGroupedBySource.get(sourceString, []) - listForSource.append(key) - dGroupedBySource[sourceString] = listForSource - - lSourceKeys = list(dGroupedBySource.keys()) - lSourceKeys.sort() - for source in lSourceKeys: - localizedStrings = dGroupedBySource[source] - localizedStrings.sort() - lOut.append("") - lOut.append(source) - lOut.append("") - for localizedString in localizedStrings: - val = dOld.get(localizedString, {}) - translation = val.get("translation", "") - comment = val.get("comment") - if len(localizedString) > doublespace_threshold and not lOut[-1] == "": - lOut.append("") - if comment != None: - lOut.append(comment) - lOut.append(f"{localizedString}={translation}") - if len(localizedString) > doublespace_threshold: - lOut.append("") - - - unusedExist = False - for key in dOld: - if key not in dkeyStrings: - val = dOld[key] - translation = val.get("translation") - comment = val.get("comment") - # only keep an unused translation if there was translated - # text or a comment associated with it - if translation != None and (translation != "" or comment): - if not unusedExist: - unusedExist = True - lOut.append("\n\n##### not used anymore #####\n") - if len(key) > doublespace_threshold and not lOut[-1] == "": - lOut.append("") - if comment != None: - lOut.append(comment) - lOut.append(f"{key}={translation}") - if len(key) > doublespace_threshold: - lOut.append("") - return "\n".join(lOut) + '\n' - -# Writes a template.txt file -# dkeyStrings is the dictionary returned by generate_template -def write_template(templ_file, dkeyStrings, mod_name): - # read existing template file to preserve comments - existing_template = import_tr_file(templ_file) - - text = strings_to_text(dkeyStrings, existing_template[0], mod_name) - mkdir_p(os.path.dirname(templ_file)) - with open(templ_file, "wt", encoding='utf-8') as template_file: - template_file.write(text) - - -# Gets all translatable strings from a lua file -def read_lua_file_strings(lua_file): - lOut = [] - with open(lua_file, encoding='utf-8') as text_file: - text = text_file.read() - #TODO remove comments here - - text = re.sub(pattern_concat, "", text) - - strings = [] - for s in pattern_lua.findall(text): - strings.append(s[1]) - for s in pattern_lua_bracketed.findall(text): - strings.append(s) - - for s in strings: - s = re.sub(r'"\.\.\s+"', "", s) - s = re.sub("@[^@=0-9]", "@@", s) - s = s.replace('\\"', '"') - s = s.replace("\\'", "'") - s = s.replace("\n", "@n") - s = s.replace("\\n", "@n") - s = s.replace("=", "@=") - lOut.append(s) - return lOut - -# Gets strings from an existing translation file -# returns both a dictionary of translations -# and the full original source text so that the new text -# can be compared to it for changes. -def import_tr_file(tr_file): - dOut = {} - text = None - if os.path.exists(tr_file): - with open(tr_file, "r", encoding='utf-8') as existing_file : - # save the full text to allow for comparison - # of the old version with the new output - text = existing_file.read() - existing_file.seek(0) - # a running record of the current comment block - # we're inside, to allow preceeding multi-line comments - # to be retained for a translation line - latest_comment_block = None - for line in existing_file.readlines(): - line = line.rstrip('\n') - if line[:3] == "###": - # Reset comment block if we hit a header - latest_comment_block = None - continue - if line[:1] == "#": - # Save the comment we're inside - if not latest_comment_block: - latest_comment_block = line - else: - latest_comment_block = latest_comment_block + "\n" + line - continue - match = pattern_tr.match(line) - if match: - # this line is a translated line - outval = {} - outval["translation"] = match.group(2) - if latest_comment_block: - # if there was a comment, record that. - outval["comment"] = latest_comment_block - latest_comment_block = None - dOut[match.group(1)] = outval - return (dOut, text) - -# Walks all lua files in the mod folder, collects translatable strings, -# and writes it to a template.txt file -# Returns a dictionary of localized strings to source file sets -# that can be used with the strings_to_text function. -def generate_template(folder, mod_name): - dOut = {} - for root, dirs, files in os.walk(folder): - for name in files: - if fnmatch.fnmatch(name, "*.lua"): - fname = os.path.join(root, name) - found = read_lua_file_strings(fname) - if params["verbose"]: - print(f"{fname}: {str(len(found))} translatable strings") - - for s in found: - sources = dOut.get(s, set()) - sources.add(f"### {os.path.basename(fname)} ###") - dOut[s] = sources - - if len(dOut) == 0: - return None - templ_file = os.path.join(folder, "locale/template.txt") - write_template(templ_file, dOut, mod_name) - return dOut - -# Updates an existing .tr file, copying the old one to a ".old" file -# if any changes have happened -# dNew is the data used to generate the template, it has all the -# currently-existing localized strings -def update_tr_file(dNew, mod_name, tr_file): - if params["verbose"]: - print(f"updating {tr_file}") - - tr_import = import_tr_file(tr_file) - dOld = tr_import[0] - textOld = tr_import[1] - - textNew = strings_to_text(dNew, dOld, mod_name) - - if textOld and textOld != textNew: - print(f"{tr_file} has changed.") - shutil.copyfile(tr_file, f"{tr_file}.old") - - with open(tr_file, "w", encoding='utf-8') as new_tr_file: - new_tr_file.write(textNew) - -# Updates translation files for the mod in the given folder -def update_mod(folder): - modname = get_modname(folder) - if modname is not None: - process_po_files(folder, modname) - print(f"Updating translations for {modname}") - data = generate_template(folder, modname) - if data == None: - print(f"No translatable strings found in {modname}") - else: - for tr_file in get_existing_tr_files(folder): - update_tr_file(data, modname, os.path.join(folder, "locale/", tr_file)) - else: - print("Unable to find modname in folder " + folder) - -# Determines if the folder being pointed to is a mod or a mod pack -# and then runs update_mod accordingly -def update_folder(folder): - is_modpack = os.path.exists(os.path.join(folder, "modpack.txt")) or os.path.exists(os.path.join(folder, "modpack.conf")) - if is_modpack: - subfolders = [f.path for f in os.scandir(folder) if f.is_dir()] - for subfolder in subfolders: - update_mod(subfolder + "/") - else: - update_mod(folder) - print("Done.") - -def run_all_subfolders(folder): - for modfolder in [f.path for f in os.scandir(folder) if f.is_dir()]: - update_folder(modfolder + "/") - - -main() diff --git a/init.lua b/init.lua index 1dad613..aa7b025 100644 --- a/init.lua +++ b/init.lua @@ -15,7 +15,7 @@ bulletin_boards.player_state = {} bulletin_boards.board_def = {} local path = minetest.get_worldpath() .. "/bulletin_boards.lua" -local f, e = loadfile(path); +local f, _ = loadfile(path); if f then bulletin_boards.global_boards = f() else @@ -58,7 +58,7 @@ local function find_next(board, start_index) index = index + 1 if index > bulletin_max then index = 1 - end + end end return index end @@ -71,7 +71,7 @@ local function find_prev(board, start_index) index = index - 1 if index < 1 then index = bulletin_max - end + end end return index end @@ -92,21 +92,21 @@ local function find_most_cullable(board_name) local player_name = bulletin.owner local count = (player_count[player_name] or 0) + 1 max_count = math.max(count, max_count) - player_count[player_name] = count + player_count[player_name] = count end end - + if total <= culling_min then return end - + local max_players = {} for player_name, count in pairs(player_count) do if count == max_count then max_players[player_name] = true end end - + local most_cullable_index local most_cullable_timestamp for i = 1, bulletin_max do @@ -118,7 +118,7 @@ local function find_most_cullable(board_name) end end end - + return most_cullable_index, most_cullable_timestamp end @@ -136,7 +136,7 @@ local function show_board(player_name, board_name) local formspec = {} local board = get_board(board_name) local current_time = minetest.get_gametime() - + local intervals = (current_time - board.last_culled)/culling_interval local cull_count, remaining_cull_time = math.modf(intervals) while cull_count > 0 do @@ -149,7 +149,7 @@ local function show_board(player_name, board_name) end end board.last_culled = current_time - math.floor(culling_interval * remaining_cull_time) - + local def = bulletin_boards.board_def[board_name] local desc = minetest.formspec_escape(def.desc) local tip @@ -160,7 +160,7 @@ local function show_board(player_name, board_name) else tip = S("Post your bulletin here") end - + formspec[#formspec+1] = "size[8,8.5]" .. "container[0,0]" .. "label[0.0,-0.25;"..desc.."]" @@ -177,7 +177,7 @@ local function show_board(player_name, board_name) short_title = short_title:sub(1, short_title_size) .. "..." end local img = bulletin.icon or "" - + formspec[#formspec+1] = "image_button["..x..",".. y*1.2 ..";1,1;"..img..";button_"..i..";]" .."label["..x..","..y*1.2-0.35 ..";"..minetest.formspec_escape(short_title).."]" @@ -204,7 +204,7 @@ local function show_bulletin(player, board_name, index) local bulletin = board[index] or {} local player_name = player:get_player_name() bulletin_boards.player_state[player_name] = {board=board_name, index=index} - + local tip local has_cost if def.cost then @@ -216,15 +216,15 @@ local function show_bulletin(player, board_name, index) tip = S("Post bulletin with this icon") has_cost = true end - + local admin = minetest.check_player_privs(player, "server") - + local formspec = {"size[8,8]" .."button[0.2,0;1,1;prev;"..S("Prev").."]" .."button[6.65,0;1,1;next;"..S("Next").."]"} local esc = minetest.formspec_escape if ((bulletin.owner == nil or bulletin.owner == player_name) and has_cost) or admin then - formspec[#formspec+1] = + formspec[#formspec+1] = "field[1.5,0.75;5.5,0;title;"..S("Title:")..";"..esc(bulletin.title or "").."]" .."textarea[0.5,1.15;7.5,7;text;"..S("Contents:")..";"..esc(bulletin.text or "").."]" .."label[0.3,7;"..S("Post:").."]" @@ -236,7 +236,7 @@ local function show_bulletin(player, board_name, index) .."tooltip[delete;"..S("Delete this bulletin").."]" .."label["..(#icons+1)*0.75-0.25 ..",7;"..S("Delete:").."]" elseif bulletin.owner then - formspec[#formspec+1] = + formspec[#formspec+1] = "label[1.4,0.5;"..S("Posted by @1", bulletin.owner).."]" .."tablecolumns[color;text]" .."tableoptions[background=#00000000;highlight=#00000000;border=false]" @@ -259,7 +259,7 @@ end minetest.register_on_player_receive_fields(function(player, formname, fields) if formname ~= "bulletin_boards:board" then return end local player_name = player:get_player_name() - for field, state in pairs(fields) do + for field, _ in pairs(fields) do if field:sub(1, #"button_") == "button_" then local i = tonumber(field:sub(#"button_"+1)) local state = bulletin_boards.player_state[player_name] @@ -267,8 +267,8 @@ minetest.register_on_player_receive_fields(function(player, formname, fields) show_bulletin(player, state.board, i) end return - end - end + end + end end) -- interpret clicks on the bulletin @@ -276,17 +276,17 @@ minetest.register_on_player_receive_fields(function(player, formname, fields) if formname ~= "bulletin_boards:bulletin" then return end local player_name = player:get_player_name() local state = bulletin_boards.player_state[player_name] - if not state then return end + if not state then return end local board = get_board(state.board) local def = bulletin_boards.board_def[state.board] if not board then return end - + -- no security needed on these actions if fields.back then bulletin_boards.player_state[player_name] = nil show_board(player_name, state.board) end - + if fields.prev then local next_index = find_prev(board, state.index) show_bulletin(player, state.board, next_index) @@ -309,19 +309,19 @@ minetest.register_on_player_receive_fields(function(player, formname, fields) -- someone's done something funny. Don't be accusatory, though - could be a race condition return end - + if fields.delete then board[state.index] = nil fields.title = "" save_boards() end - + local player_inventory = minetest.get_inventory({type="player", name=player_name}) local has_cost = true if def.cost then has_cost = player_inventory:contains_item("main", def.cost) end - + if fields.text ~= "" and (has_cost or admin) then for field, _ in pairs(fields) do if field:sub(1, #"save_") == "save_" then @@ -364,7 +364,7 @@ local base_icons = { local function generate_random_board(rez, count, icons) icons = icons or base_icons local tex = {"([combine:"..rez.."x"..rez} - for i = 1, count do + for _ = 1, count do tex[#tex+1] = ":"..math.random(1,rez-32)..","..math.random(1,rez-32) .."="..icons[math.random(1,#icons)] end @@ -399,7 +399,7 @@ local function register_board(board_name, board_def) local player_name = clicker:get_player_name() show_board(player_name, board_name) end, - + on_construct = function(pos) local meta = minetest.get_meta(pos) meta:set_string("infotext", board_def.desc or "") @@ -442,13 +442,13 @@ minetest.register_craft({ end -if core.get_modpath("mcl_core") then +if minetest.get_modpath("mcl_core") then register_board("bulletin_boards:wood", { desc = S("Public Bulletin Board"), cost = "mcl_core:paper", icons = base_icons, }) - core.register_craft({ + minetest.register_craft({ output = "bulletin_boards:wood", recipe = { {'group:wood', 'group:wood', 'group:wood'}, @@ -464,7 +464,7 @@ if core.get_modpath("mcl_core") then foreground = "bulletin_boards_frame_copper.png", icons = base_icons, }) - core.register_craft({ + minetest.register_craft({ output = "bulletin_boards:copper", recipe = { {"mcl_copper:copper_ingot", "mcl_copper:copper_ingot", "mcl_copper:copper_ingot"}, diff --git a/mod.conf b/mod.conf index fc35031..c24df55 100644 --- a/mod.conf +++ b/mod.conf @@ -1,3 +1,3 @@ -name=bulletin_boards +name = bulletin_boards description = Allows creation of global bulletin boards where players can post public messages optional_depends = default, mcl_core, mcl_copper \ No newline at end of file