libervia-backend: sat_frontends/jp/common.py annotate

annotate sat_frontends/jp/common.py @ 2755:12d1ca646af1

plugin manhole: manhole debug plugin, first draft: this plugin open a telnet server which open a Python interpreter and allows to inspect the backend while it is running. To enable it, the settings "manhole_debug_dangerous_port_int" must be set to the desired TCP port in [DEFAULT] section of sat.conf. A warning will be logged if the server is enabled. Currently only a telnet server is available, and no login is required. This may change in the futur to enable login/password and ssh access, or even an XMPP access. This is a debugging feature and must only be used during development. Once in the Python interpreter, the "host" variable is accessible.

author	Goffi <goffi@goffi.org>
date	Fri, 04 Jan 2019 18:59:24 +0100
parents	56f94936df1e
children	003b8b4b56a7

rev	line source
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/env python2
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	3
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	4 # jp: a SàT command line tool
2483 0046283a285d dates update Goffi <goffi@goffi.org> parents: 2414 diff changeset	5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	6
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	11
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	16
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	19
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	20 from sat_frontends.jp.constants import Const as C
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	21 from sat.core.i18n import _
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	22 from sat.core import exceptions
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	23 from sat.tools.common import regex
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	24 from sat.tools.common.ansi import ANSI as A
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	25 from sat.tools.common import uri as xmpp_uri
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	26 from sat.tools import config
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	27 from ConfigParser import NoSectionError, NoOptionError
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	28 from collections import namedtuple
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	29 from functools import partial
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	30 import json
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	31 import os
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	32 import os.path
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	33 import time
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	34 import tempfile
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	35 import subprocess
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	36 import glob
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	37 import shlex
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	38
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	39 # defaut arguments used for some known editors (editing with metadata)
2523 21d43eab3fb9 jp (common): assure nosplitright in default commands for edition with vim Goffi <goffi@goffi.org> parents: 2493 diff changeset	40 VIM_SPLIT_ARGS = "-c 'set nospr\|vsplit\|wincmd w\|next\|wincmd w'"
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	41 EMACS_SPLIT_ARGS = '--eval "(split-window-horizontally)"'
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	42 EDITOR_ARGS_MAGIC = {
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	43 "vim": VIM_SPLIT_ARGS + " {content_file} {metadata_file}",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	44 "gvim": VIM_SPLIT_ARGS + " --nofork {content_file} {metadata_file}",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	45 "emacs": EMACS_SPLIT_ARGS + " {content_file} {metadata_file}",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	46 "xemacs": EMACS_SPLIT_ARGS + " {content_file} {metadata_file}",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	47 "nano": " -F {content_file} {metadata_file}",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	48 }
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	49
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	50 SECURE_UNLINK_MAX = 10
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	51 SECURE_UNLINK_DIR = ".backup"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	52 METADATA_SUFF = "_metadata.json"
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	53
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	54
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	55 def ansi_ljust(s, width):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	56 """ljust method handling ANSI escape codes"""
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	57 cleaned = regex.ansiRemove(s)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	58 return s + u" " * (width - len(cleaned))
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	59
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	60
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	61 def ansi_center(s, width):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	62 """ljust method handling ANSI escape codes"""
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	63 cleaned = regex.ansiRemove(s)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	64 diff = width - len(cleaned)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	65 half = diff / 2
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	66 return half * u" " + s + (half + diff % 2) * u" "
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	67
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	68
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	69 def ansi_rjust(s, width):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	70 """ljust method handling ANSI escape codes"""
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	71 cleaned = regex.ansiRemove(s)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	72 return u" " * (width - len(cleaned)) + s
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	73
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	74
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	75 def getTmpDir(sat_conf, cat_dir, sub_dir=None):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	76 """Return directory used to store temporary files
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	77
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	78 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	79 @param cat_dir(unicode): directory of the category (e.g. "blog")
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	80 @param sub_dir(str): sub directory where data need to be put
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	81 profile can be used here, or special directory name
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	82 sub_dir will be escaped to be usable in path (use regex.pathUnescape to find
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	83 initial str)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	84 @return (str): path to the dir
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	85 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	86 local_dir = config.getConfig(sat_conf, "", "local_dir", Exception)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	87 path = [local_dir.encode("utf-8"), cat_dir.encode("utf-8")]
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	88 if sub_dir is not None:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	89 path.append(regex.pathEscape(sub_dir))
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	90 return os.path.join(*path)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	91
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	92
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	93 def parse_args(host, cmd_line, **format_kw):
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	94 """Parse command arguments
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	95
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	96 @param cmd_line(unicode): command line as found in sat.conf
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	97 @param format_kw: keywords used for formating
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	98 @return (list(unicode)): list of arguments to pass to subprocess function
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	99 """
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	100 try:
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	101 # we split the arguments and add the known fields
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	102 # we split arguments first to avoid escaping issues in file names
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	103 return [a.format(**format_kw) for a in shlex.split(cmd_line)]
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	104 except ValueError as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	105 host.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	106 u"Couldn't parse editor cmd [{cmd}]: {reason}".format(cmd=cmd_line, reason=e)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	107 )
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	108 return []
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	109
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	110
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	111 class BaseEdit(object):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	112 u"""base class for editing commands
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	113
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	114 This class allows to edit file for PubSub or something else.
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	115 It works with temporary files in SàT local_dir, in a "cat_dir" subdir
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	116 """
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	117
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	118 def __init__(self, host, cat_dir, use_metadata=False):
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	119 """
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	120 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	121 @param cat_dir(unicode): directory to use for drafts
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	122 this will be a sub-directory of SàT's local_dir
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	123 @param use_metadata(bool): True is edition need a second file for metadata
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	124 most of signature change with use_metadata with an additional metadata argument.
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	125 This is done to raise error if a command needs metadata but forget the flag, and vice versa
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	126 """
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	127 self.host = host
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	128 self.sat_conf = config.parseMainConf()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	129 self.cat_dir_str = cat_dir.encode("utf-8")
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	130 self.use_metadata = use_metadata
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	131
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	132 def secureUnlink(self, path):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	133 """Unlink given path after keeping it for a while
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	134
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	135 This method is used to prevent accidental deletion of a draft
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	136 If there are more file in SECURE_UNLINK_DIR than SECURE_UNLINK_MAX,
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	137 older file are deleted
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	138 @param path(str): file to unlink
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	139 """
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	140 if not os.path.isfile(path):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	141 raise OSError(u"path must link to a regular file")
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	142 if not path.startswith(getTmpDir(self.sat_conf, self.cat_dir_str)):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	143 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	144 u"File {} is not in SàT temporary hierarchy, we do not remove it".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	145 path.decode("utf-8")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	146 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	147 2,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	148 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	149 return
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	150 # we have 2 files per draft with use_metadata, so we double max
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	151 unlink_max = SECURE_UNLINK_MAX * 2 if self.use_metadata else SECURE_UNLINK_MAX
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	152 backup_dir = getTmpDir(self.sat_conf, self.cat_dir_str, SECURE_UNLINK_DIR)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	153 if not os.path.exists(backup_dir):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	154 os.makedirs(backup_dir)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	155 filename = os.path.basename(path)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	156 backup_path = os.path.join(backup_dir, filename)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	157 # we move file to backup dir
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	158 self.host.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	159 u"Backuping file {src} to {dst}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	160 src=path.decode("utf-8"), dst=backup_path.decode("utf-8")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	161 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	162 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	163 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	164 os.rename(path, backup_path)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	165 # and if we exceeded the limit, we remove older file
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	166 backup_files = [os.path.join(backup_dir, f) for f in os.listdir(backup_dir)]
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	167 if len(backup_files) > unlink_max:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	168 backup_files.sort(key=lambda path: os.stat(path).st_mtime)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	169 for path in backup_files[: len(backup_files) - unlink_max]:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	170 self.host.disp(u"Purging backup file {}".format(path.decode("utf-8")), 2)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	171 os.unlink(path)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	172
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	173 def runEditor(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	174 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	175 editor_args_opt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	176 content_file_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	177 content_file_obj,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	178 meta_file_path=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	179 meta_ori=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	180 ):
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	181 """run editor to edit content and metadata
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	182
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	183 @param editor_args_opt(unicode): option in [jp] section in configuration for
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	184 specific args
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	185 @param content_file_path(str): path to the content file
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	186 @param content_file_obj(file): opened file instance
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	187 @param meta_file_path(str, None): metadata file path
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	188 if None metadata will not be used
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	189 @param meta_ori(dict, None): original cotent of metadata
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	190 can't be used if use_metadata is False
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	191 """
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	192 if not self.use_metadata:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	193 assert meta_file_path is None
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	194 assert meta_ori is None
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	195
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	196 # we calculate hashes to check for modifications
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	197 import hashlib
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	198
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	199 content_file_obj.seek(0)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	200 tmp_ori_hash = hashlib.sha1(content_file_obj.read()).digest()
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	201 content_file_obj.close()
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	202
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	203 # we prepare arguments
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	204 editor = config.getConfig(self.sat_conf, "jp", "editor") or os.getenv(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	205 "EDITOR", "vi"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	206 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	207 try:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	208 # is there custom arguments in sat.conf ?
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	209 editor_args = config.getConfig(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	210 self.sat_conf, "jp", editor_args_opt, Exception
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	211 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	212 except (NoOptionError, NoSectionError):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	213 # no, we check if we know the editor and have special arguments
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	214 if self.use_metadata:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	215 editor_args = EDITOR_ARGS_MAGIC.get(os.path.basename(editor), "")
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	216 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	217 editor_args = ""
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	218 parse_kwargs = {"content_file": content_file_path}
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	219 if self.use_metadata:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	220 parse_kwargs["metadata_file"] = meta_file_path
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	221 args = parse_args(self.host, editor_args, **parse_kwargs)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	222 if not args:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	223 args = [content_file_path]
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	224
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	225 # actual editing
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	226 editor_exit = subprocess.call([editor] + args)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	227
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	228 # edition will now be checked, and data will be sent if it was a success
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	229 if editor_exit != 0:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	230 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	231 u"Editor exited with an error code, so temporary file has not be deleted, and item is not published.\nYou can find temporary file at {path}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	232 path=content_file_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	233 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	234 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	235 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	236 else:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	237 # main content
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	238 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	239 with open(content_file_path, "rb") as f:
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	240 content = f.read()
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	241 except (OSError, IOError):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	242 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	243 u"Can read file at {content_path}, have it been deleted?\nCancelling edition".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	244 content_path=content_file_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	245 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	246 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	247 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	248 self.host.quit(C.EXIT_NOT_FOUND)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	249
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	250 # metadata
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	251 if self.use_metadata:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	252 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	253 with open(meta_file_path, "rb") as f:
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	254 metadata = json.load(f)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	255 except (OSError, IOError):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	256 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	257 u"Can read file at {meta_file_path}, have it been deleted?\nCancelling edition".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	258 content_path=content_file_path, meta_path=meta_file_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	259 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	260 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	261 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	262 self.host.quit(C.EXIT_NOT_FOUND)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	263 except ValueError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	264 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	265 u"Can't parse metadata, please check it is correct JSON format. Cancelling edition.\n"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	266 + "You can find tmp file at {content_path} and temporary meta file at {meta_path}.".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	267 content_path=content_file_path, meta_path=meta_file_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	268 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	269 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	270 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	271 self.host.quit(C.EXIT_DATA_ERROR)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	272
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	273 if self.use_metadata and not C.bool(metadata.get("publish", "true")):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	274 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	275 u'Publication blocked by "publish" key in metadata, cancelling edition.\n\n'
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	276 + "temporary file path:\t{content_path}\nmetadata file path:\t{meta_path}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	277 content_path=content_file_path, meta_path=meta_file_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	278 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	279 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	280 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	281 self.host.quit()
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	282
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	283 if len(content) == 0:
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	284 self.disp(u"Content is empty, cancelling the edition")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	285 if not content_file_path.startswith(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	286 getTmpDir(self.sat_conf, self.cat_dir_str)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	287 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	288 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	289 u"File are not in SàT temporary hierarchy, we do not remove them",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	290 2,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	291 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	292 self.host.quit()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	293 self.disp(u"Deletion of {}".format(content_file_path.decode("utf-8")), 2)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	294 os.unlink(content_file_path)
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	295 if self.use_metadata:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	296 self.disp(u"Deletion of {}".format(meta_file_path.decode("utf-8")), 2)
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	297 os.unlink(meta_file_path)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	298 self.host.quit()
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	299
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	300 # time to re-check the hash
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	301 elif tmp_ori_hash == hashlib.sha1(content).digest() and (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	302 not self.use_metadata or meta_ori == metadata
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	303 ):
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	304 self.disp(u"The content has not been modified, cancelling the edition")
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	305 self.host.quit()
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	306
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	307 else:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	308 # we can now send the item
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	309 content = content.decode("utf-8-sig") # we use utf-8-sig to avoid BOM
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	310 try:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	311 if self.use_metadata:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	312 self.publish(content, metadata)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	313 else:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	314 self.publish(content)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	315 except Exception as e:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	316 if self.use_metadata:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	317 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	318 u"Error while sending your item, the temporary files have been kept at {content_path} and {meta_path}: {reason}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	319 content_path=content_file_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	320 meta_path=meta_file_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	321 reason=e,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	322 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	323 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	324 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	325 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	326 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	327 u"Error while sending your item, the temporary file has been kept at {content_path}: {reason}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	328 content_path=content_file_path, reason=e
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	329 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	330 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	331 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	332 self.host.quit(1)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	333
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	334 self.secureUnlink(content_file_path)
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	335 if self.use_metadata:
5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	336 self.secureUnlink(meta_file_path)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	337
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	338 def publish(self, content):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	339 # if metadata is needed, publish will be called with it last argument
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	340 raise NotImplementedError
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	341
2351 3c0a3fae1862 jp (pubsub/node): added schema (set/edit/get) commands to manipulate PubSub node schema Goffi <goffi@goffi.org> parents: 2345 diff changeset	342 def getTmpFile(self):
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	343 """Create a temporary file
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	344
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	345 @param suff (str): suffix to use for the filename
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	346 @return (tuple(file, str)): opened (w+b) file object and file path
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	347 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	348 suff = "." + self.getTmpSuff()
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	349 cat_dir_str = self.cat_dir_str
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	350 tmp_dir = getTmpDir(self.sat_conf, self.cat_dir_str, self.profile.encode("utf-8"))
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	351 if not os.path.exists(tmp_dir):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	352 try:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	353 os.makedirs(tmp_dir)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	354 except OSError as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	355 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	356 u"Can't create {path} directory: {reason}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	357 path=tmp_dir, reason=e
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	358 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	359 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	360 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	361 self.host.quit(1)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	362 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	363 fd, path = tempfile.mkstemp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	364 suffix=suff.encode("utf-8"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	365 prefix=time.strftime(cat_dir_str + "_%Y-%m-%d_%H:%M:%S_"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	366 dir=tmp_dir,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	367 text=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	368 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	369 return os.fdopen(fd, "w+b"), path
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	370 except OSError as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	371 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	372 u"Can't create temporary file: {reason}".format(reason=e), error=True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	373 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	374 self.host.quit(1)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	375
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	376 def getCurrentFile(self, profile):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	377 """Get most recently edited file
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	378
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	379 @param profile(unicode): profile linked to the draft
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	380 @return(str): full path of current file
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	381 """
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	382 # we guess the item currently edited by choosing
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	383 # the most recent file corresponding to temp file pattern
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	384 # in tmp_dir, excluding metadata files
2273 5f0dbf42aa9c jp (blog, common): various fixes in common and blog: Goffi <goffi@goffi.org> parents: 2270 diff changeset	385 cat_dir_str = self.cat_dir_str
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	386 tmp_dir = getTmpDir(self.sat_conf, self.cat_dir_str, profile.encode("utf-8"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	387 available = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	388 path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	389 for path in glob.glob(os.path.join(tmp_dir, cat_dir_str + "_*"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	390 if not path.endswith(METADATA_SUFF)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	391 ]
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	392 if not available:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	393 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	394 u"Could not find any content draft in {path}".format(path=tmp_dir),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	395 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	396 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	397 self.host.quit(1)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	398 return max(available, key=lambda path: os.stat(path).st_mtime)
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	399
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	400 def getItemData(self, service, node, item):
2280 4bc9a2c2d6c9 jp (pubsub, common): fixed last item edition (keep item id instead of creating a new one) Goffi <goffi@goffi.org> parents: 2279 diff changeset	401 """return formatted content, metadata (or not if use_metadata is false), and item id"""
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	402 raise NotImplementedError
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	403
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	404 def getTmpSuff(self):
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	405 """return suffix used for content file"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	406 return u"xml"
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	407
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	408 def getItemPath(self):
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	409 """retrieve item path (i.e. service and node) from item argument
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	410
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	411 This method is obviously only useful for edition of PubSub based features
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	412 """
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	413 service = self.args.service
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	414 node = self.args.node
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	415 item = self.args.item
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	416 last_item = self.args.last_item
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	417
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	418 if self.args.current:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	419 # user wants to continue current draft
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	420 content_file_path = self.getCurrentFile(self.profile)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	421 self.disp(u"Continuing edition of current draft", 2)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	422 content_file_obj = open(content_file_path, "r+b")
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	423 # we seek at the end of file in case of an item already exist
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	424 # this will write content of the existing item at the end of the draft.
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	425 # This way no data should be lost.
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	426 content_file_obj.seek(0, os.SEEK_END)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	427 elif self.args.draft_path:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	428 # there is an existing draft that we use
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	429 content_file_path = os.path.expanduser(self.args.item)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	430 content_file_obj = open(content_file_path, "r+b")
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	431 # we seek at the end for the same reason as above
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	432 content_file_obj.seek(0, os.SEEK_END)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	433 else:
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	434 # we need a temporary file
2351 3c0a3fae1862 jp (pubsub/node): added schema (set/edit/get) commands to manipulate PubSub node schema Goffi <goffi@goffi.org> parents: 2345 diff changeset	435 content_file_obj, content_file_path = self.getTmpFile()
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	436
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	437 if item or last_item:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	438 self.disp(u"Editing requested published item", 2)
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	439 try:
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	440 if self.use_metadata:
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	441 content, metadata, item = self.getItemData(service, node, item)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	442 else:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	443 content, item = self.getItemData(service, node, item)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	444 except Exception as e:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	445 # FIXME: ugly but we have not good may to check errors in bridge
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	446 if u"item-not-found" in unicode(e):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	447 # item doesn't exist, we create a new one with requested id
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	448 metadata = None
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	449 if last_item:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	450 self.disp(_(u"no item found at all, we create a new one"), 2)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	451 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	452 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	453 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	454 u'item "{item_id}" not found, we create a new item with this id'
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	455 ).format(item_id=item),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	456 2,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	457 )
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	458 content_file_obj.seek(0)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	459 else:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	460 self.disp(u"Error while retrieving item: {}".format(e))
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	461 self.host.quit(C.EXIT_ERROR)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	462 else:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	463 # item exists, we write content
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	464 if content_file_obj.tell() != 0:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	465 # we already have a draft,
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	466 # we copy item content after it and add an indicator
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	467 content_file_obj.write("\n*****\n")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	468 content_file_obj.write(content.encode("utf-8"))
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	469 content_file_obj.seek(0)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	470 self.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	471 _(u'item "{item_id}" found, we edit it').format(item_id=item), 2
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	472 )
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	473 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	474 self.disp(u"Editing a new item", 2)
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	475 if self.use_metadata:
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	476 metadata = None
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	477
606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	478 if self.use_metadata:
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	479 return service, node, item, content_file_path, content_file_obj, metadata
2269 606ff34d30f2 jp (blog, common): moved and improved edit code from blog: Goffi <goffi@goffi.org> parents: diff changeset	480 else:
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2523 diff changeset	481 return service, node, item, content_file_path, content_file_obj
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	482
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	483
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	484 class Table(object):
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	485 def __init__(self, host, data, headers=None, filters=None, use_buffer=False):
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	486 """
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	487 @param data(iterable[list]): table data
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	488 all lines must have the same number of columns
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	489 @param headers(iterable[unicode], None): names/titles of the columns
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	490 if not None, must have same number of columns as data
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	491 @param filters(iterable[(callable, unicode)], None): values filters
2610 c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	492 the callable will get 2 arguments:
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	493 - current column value
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	494 - RowData with all columns values
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	495 if may also only use 1 argument, which will then be current col value.
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	496 the callable must return a string
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	497 if it's unicode, it will be used with .format and must countain u'{}' which will be replaced with the string
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	498 if not None, must have same number of columns as data
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	499 @param use_buffer(bool): if True, bufferise output instead of printing it directly
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	500 """
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	501 self.host = host
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	502 self._buffer = [] if use_buffer else None
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	503 # headers are columns names/titles, can be None
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	504 self.headers = headers
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	505 # sizes fof columns without headers,
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	506 # headers may be larger
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	507 self.sizes = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	508 # rows countains one list per row with columns values
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	509 self.rows = []
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	510
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	511 size = None
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	512 if headers:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	513 row_cls = namedtuple("RowData", headers)
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	514 else:
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	515 row_cls = tuple
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	516
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	517 for row_data in data:
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	518 new_row = []
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	519 row_data_list = list(row_data)
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	520 for idx, value in enumerate(row_data_list):
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	521 if filters is not None and filters[idx] is not None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	522 filter_ = filters[idx]
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	523 if isinstance(filter_, basestring):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	524 col_value = filter_.format(value)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	525 else:
2610 c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	526 try:
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	527 col_value = filter_(value, row_cls(*row_data_list))
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	528 except TypeError:
c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	529 col_value = filter_(value)
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	530 # we count size without ANSI code as they will change length of the string
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	531 # when it's mostly style/color changes.
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	532 col_size = len(regex.ansiRemove(col_value))
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	533 else:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	534 col_value = unicode(value)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	535 col_size = len(col_value)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	536 new_row.append(col_value)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	537 if size is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	538 self.sizes.append(col_size)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	539 else:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	540 self.sizes[idx] = max(self.sizes[idx], col_size)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	541 if size is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	542 size = len(new_row)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	543 if headers is not None and len(headers) != size:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	544 raise exceptions.DataError(u"headers size is not coherent with rows")
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	545 else:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	546 if len(new_row) != size:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	547 raise exceptions.DataError(u"rows size is not coherent")
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	548 self.rows.append(new_row)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	549
2344 78ffb9ce57a4 jp (common): fixed empty table display when headers are specified Goffi <goffi@goffi.org> parents: 2334 diff changeset	550 if not data and headers is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	551 # the table is empty, we print headers at their lenght
2344 78ffb9ce57a4 jp (common): fixed empty table display when headers are specified Goffi <goffi@goffi.org> parents: 2334 diff changeset	552 self.sizes = [len(h) for h in headers]
78ffb9ce57a4 jp (common): fixed empty table display when headers are specified Goffi <goffi@goffi.org> parents: 2334 diff changeset	553
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	554 @property
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	555 def string(self):
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	556 if self._buffer is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	557 raise exceptions.InternalError(u"buffer must be used to get a string")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	558 return u"\n".join(self._buffer)
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	559
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	560 @staticmethod
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	561 def readDictValues(data, keys, defaults=None):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	562 if defaults is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	563 defaults = {}
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	564 for key in keys:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	565 try:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	566 yield data[key]
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	567 except KeyError as e:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	568 default = defaults.get(key)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	569 if default is not None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	570 yield default
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	571 else:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	572 raise e
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	573
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	574 @classmethod
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	575 def fromDict(cls, host, data, keys=None, headers=None, filters=None, defaults=None):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	576 """Prepare a table to display it
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	577
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	578 the whole data will be read and kept into memory,
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	579 to be printed
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	580 @param data(list[dict[unicode, unicode]]): data to create the table from
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	581 @param keys(iterable[unicode], None): keys to get
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	582 if None, all keys will be used
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	583 @param headers(iterable[unicode], None): name of the columns
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	584 names must be in same order as keys
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	585 @param filters(dict[unicode, (callable,unicode)), None): filter to use on values
2610 c9dddf691d7b jp (common): allow tables filters callbacks to have only one argument Goffi <goffi@goffi.org> parents: 2562 diff changeset	586 keys correspond to keys to filter, and value is the same as for Table.__init__
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	587 @param defaults(dict[unicode, unicode]): default value to use
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	588 if None, an exception will be raised if not value is found
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	589 """
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	590 if keys is None and headers is not None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	591 # FIXME: keys are not needed with OrderedDict,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	592 raise exceptions.DataError(u"You must specify keys order to used headers")
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	593 if keys is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	594 keys = data[0].keys()
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	595 if headers is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	596 headers = keys
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	597 filters = [filters.get(k) for k in keys]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	598 return cls(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	599 host, (cls.readDictValues(d, keys, defaults) for d in data), headers, filters
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	600 )
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	601
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	602 def _headers(self, head_sep, headers, sizes, alignment=u"left", style=None):
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	603 """Render headers
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	604
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	605 @param head_sep(unicode): sequence to use as separator
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	606 @param alignment(unicode): how to align, can be left, center or right
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	607 @param style(unicode, iterable[unicode], None): ANSI escape sequences to apply
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	608 @param headers(list[unicode]): headers to show
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	609 @param sizes(list[int]): sizes of columns
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	610 """
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	611 rendered_headers = []
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	612 if isinstance(style, basestring):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	613 style = [style]
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	614 for idx, header in enumerate(headers):
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	615 size = sizes[idx]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	616 if alignment == u"left":
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	617 rendered = header[:size].ljust(size)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	618 elif alignment == u"center":
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	619 rendered = header[:size].center(size)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	620 elif alignment == u"right":
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	621 rendered = header[:size].rjust(size)
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	622 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	623 raise exceptions.InternalError(u"bad alignment argument")
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	624 if style:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	625 args = style + [rendered]
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	626 rendered = A.color(*args)
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	627 rendered_headers.append(rendered)
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	628 return head_sep.join(rendered_headers)
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	629
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	630 def _disp(self, data):
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	631 """output data (can be either bufferised or printed)"""
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	632 if self._buffer is not None:
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	633 self._buffer.append(data)
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	634 else:
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	635 self.host.disp(data)
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	636
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	637 def display(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	638 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	639 head_alignment=u"left",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	640 columns_alignment=u"left",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	641 head_style=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	642 show_header=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	643 show_borders=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	644 hide_cols=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	645 col_sep=u" │ ",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	646 top_left=u"┌",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	647 top=u"─",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	648 top_sep=u"─┬─",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	649 top_right=u"┐",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	650 left=u"│",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	651 right=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	652 head_sep=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	653 head_line=u"┄",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	654 head_line_left=u"├",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	655 head_line_sep=u"┄┼┄",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	656 head_line_right=u"┤",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	657 bottom_left=u"└",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	658 bottom=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	659 bottom_sep=u"─┴─",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	660 bottom_right=u"┘",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	661 ):
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	662 """Print the table
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	663
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	664 @param show_header(bool): True if header need no be shown
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	665 @param show_borders(bool): True if borders need no be shown
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	666 @param hide_cols(None, iterable(unicode)): columns which should not be displayed
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	667 @param head_alignment(unicode): how to align headers, can be left, center or right
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	668 @param columns_alignment(unicode): how to align columns, can be left, center or right
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	669 @param col_sep(unicode): separator betweens columns
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	670 @param head_line(unicode): character to use to make line under head
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	671 @param disp(callable, None): method to use to display the table
c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	672 None to use self.host.disp
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	673 """
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	674 if not self.sizes:
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	675 # the table is empty
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	676 return
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	677 col_sep_size = len(regex.ansiRemove(col_sep))
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	678
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	679 # if we have columns to hide, we remove them from headers and size
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	680 if not hide_cols:
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	681 headers = self.headers
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	682 sizes = self.sizes
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	683 else:
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	684 headers = list(self.headers)
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	685 sizes = self.sizes[:]
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	686 ignore_idx = [headers.index(to_hide) for to_hide in hide_cols]
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	687 for to_hide in hide_cols:
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	688 hide_idx = headers.index(to_hide)
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	689 del headers[hide_idx]
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	690 del sizes[hide_idx]
984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	691
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	692 if right is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	693 right = left
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	694 if top_sep is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	695 top_sep = col_sep_size * top
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	696 if head_sep is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	697 head_sep = col_sep
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	698 if bottom is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	699 bottom = top
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	700 if bottom_sep is None:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	701 bottom_sep = col_sep_size * bottom
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	702 if not show_borders:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	703 left = right = head_line_left = head_line_right = u""
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	704 # top border
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	705 if show_borders:
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	706 self._disp(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	707 top_left + top_sep.join([top * size for size in sizes]) + top_right
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	708 )
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	709
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	710 # headers
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	711 if show_header:
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	712 self._disp(
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	713 left
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	714 + self._headers(head_sep, headers, sizes, head_alignment, head_style)
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	715 + right
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	716 )
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	717 # header line
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	718 self._disp(
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	719 head_line_left
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	720 + head_line_sep.join([head_line * size for size in sizes])
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	721 + head_line_right
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	722 )
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	723
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	724 # content
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	725 if columns_alignment == u"left":
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	726 alignment = lambda idx, s: ansi_ljust(s, sizes[idx])
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	727 elif columns_alignment == u"center":
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	728 alignment = lambda idx, s: ansi_center(s, sizes[idx])
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	729 elif columns_alignment == u"right":
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	730 alignment = lambda idx, s: ansi_rjust(s, sizes[idx])
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	731 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	732 raise exceptions.InternalError(u"bad columns alignment argument")
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	733
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	734 for row in self.rows:
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	735 if hide_cols:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	736 row = [v for idx, v in enumerate(row) if idx not in ignore_idx]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	737 self._disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	738 left
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	739 + col_sep.join([alignment(idx, c) for idx, c in enumerate(row)])
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	740 + right
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	741 )
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	742
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	743 if show_borders:
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	744 # bottom border
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	745 self._disp(
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	746 bottom_left
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	747 + bottom_sep.join([bottom * size for size in sizes])
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	748 + bottom_right
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	749 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	750 # we return self so string can be used after display (table.display().string)
2345 c57bc0fe17d9 jp (common): added use_buffer argument in Table: Goffi <goffi@goffi.org> parents: 2344 diff changeset	751 return self
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	752
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	753 def display_blank(self, **kwargs):
276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	754 """Display table without visible borders"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	755 kwargs_ = {"col_sep": u" ", "head_line_sep": u" ", "show_borders": False}
2298 276e546b7619 jp (common): new ansi_ljust, ansi_rjust and ansi_center command + table: Goffi <goffi@goffi.org> parents: 2280 diff changeset	756 kwargs_.update(kwargs)
2493 984792a451bc jp (common/table): a column can be hidden + fix for empty tables Goffi <goffi@goffi.org> parents: 2483 diff changeset	757 return self.display(**kwargs_)
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	758
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	759
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	760 class URIFinder(object):
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	761 """Helper class to find URIs in well-known locations"""
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	762
2558 501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	763 def __init__(self, command, path, key, callback, meta_map=None):
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	764 """
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	765 @param command(CommandBase): command instance
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	766 args of this instance will be updated with found values
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	767 @param path(unicode): absolute path to use as a starting point to look for URIs
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	768 @param key(unicode): key to look for
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	769 @param callback(callable): method to call once URIs are found (or not)
2558 501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	770 @param meta_map(dict, None): if not None, map metadata to arg name
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	771 key is metadata used attribute name
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	772 value is name to actually use, or None to ignore
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	773 use empty dict to only retrieve URI
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	774 possible keys are currently:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	775 - labels
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	776 """
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	777 if not command.args.service and not command.args.node:
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	778 self.host = command.host
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	779 self.args = command.args
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	780 self.key = key
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	781 self.callback = callback
2558 501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	782 self.meta_map = meta_map
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	783 self.host.bridge.URIFind(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	784 path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	785 [key],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	786 callback=self.URIFindCb,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	787 errback=partial(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	788 command.errback,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	789 msg=_(u"can't find " + key + u" URI: {}"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	790 exit_code=C.EXIT_BRIDGE_ERRBACK,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	791 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	792 )
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	793 else:
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	794 callback()
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	795
2558 501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	796 def setMetadataList(self, uri_data, key):
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	797 """Helper method to set list of values from metadata
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	798
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	799 @param uri_data(dict): data of the found URI
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	800 @param key(unicode): key of the value to retrieve
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	801 """
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	802 new_values_json = uri_data.get(key)
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	803 if uri_data is not None:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	804 if self.meta_map is None:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	805 dest = key
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	806 else:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	807 dest = self.meta_map.get(key)
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	808 if dest is None:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	809 return
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	810
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	811 try:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	812 values = getattr(self.args, key)
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	813 except AttributeError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	814 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	815 u'there is no "{key}" arguments'.format(key=key)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	816 )
2558 501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	817 else:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	818 if values is None:
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	819 values = []
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	820 values.extend(json.loads(new_values_json))
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	821 setattr(self.args, dest, values)
501b0f827f63 jp (merge-request,common): fixed URIFinder when metadata are not needed: Goffi <goffi@goffi.org> parents: 2554 diff changeset	822
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	823 def URIFindCb(self, uris_data):
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	824 try:
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	825 uri_data = uris_data[self.key]
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	826 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	827 self.host.disp(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	828 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	829 u"No {key} URI specified for this project, please specify service and node"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	830 ).format(key=self.key),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	831 error=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	832 )
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	833 self.host.quit(C.EXIT_NOT_FOUND)
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	834 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	835 uri = uri_data[u"uri"]
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2551 diff changeset	836
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	837 self.setMetadataList(uri_data, u"labels")
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	838 parsed_uri = xmpp_uri.parseXMPPUri(uri)
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	839 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	840 self.args.service = parsed_uri[u"path"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2610 diff changeset	841 self.args.node = parsed_uri[u"node"]
2551 b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	842 except KeyError:
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	843 self.host.disp(_(u"Invalid URI found: {uri}").format(uri=uri), error=True)
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	844 self.host.quit(C.EXIT_DATA_ERROR)
b27165bf160c jp (merge-request/set): if service and node are not specified, URIFinder is now used + ask confirmation before publishing Goffi <goffi@goffi.org> parents: 2532 diff changeset	845 self.callback()

Mercurial > libervia-backend

annotate sat_frontends/jp/common.py @ 2755:12d1ca646af1