libervia-backend: frontends/src/jp/cmd

annotate frontends/src/jp/cmd_blog.py @ 2023:224c8b0886bc

plugin XEP-0184: Implementation of XEP-0184 (Message Delivery Receipts)

author	Geoffrey POUZET <chteufleur@kingpenguin.tk>
date	Thu, 28 Jul 2016 19:11:31 +0200
parents	5fbe09b9b568
children	b4a515e36631

rev	line source
1960 3e168cde7a7d jp: fixed shebang python call Goffi <goffi@goffi.org> parents: 1929 diff changeset	1 #!/usr/bin/env python2
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	3
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	4 # jp: a SàT command line tool
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	6
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	11
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	16
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	19
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	20
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	21 import base
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	22 from sat.core.i18n import _
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	23 from sat.core.constants import Const as C
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	24 from sat.tools import config
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	25 from ConfigParser import NoSectionError, NoOptionError
1834 6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	26 import json
1887 16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	27 import sys
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	28 import os.path
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	29 import os
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	30 import time
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	31 import tempfile
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	32 import subprocess
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	33 import shlex
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	34 import glob
1919 d3354c80bd1f core (tools): moved common to a separate package, and put data method in a data_format module Goffi <goffi@goffi.org> parents: 1912 diff changeset	35 from sat.tools.common import data_format
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	36 from sat.tools.common import regex
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	37
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	38 __commands__ = ["Blog"]
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	39
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	40 # extensions to use with known syntaxes
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	41 SYNTAX_EXT = {
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	42 '': 'txt', # used when the syntax is not found
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	43 "XHTML": "xhtml",
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	44 "markdown": "md"
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	45 }
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	46
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	47 # defaut arguments used for some known editors
1873 6ec54626610c jp (blog): add to EDITOR_ARGS_MAGIC parameters for (x)emacs and nano souliane <souliane@mailoo.org> parents: 1872 diff changeset	48 VIM_SPLIT_ARGS = "-c 'vsplit\|wincmd w\|next\|wincmd w'"
6ec54626610c jp (blog): add to EDITOR_ARGS_MAGIC parameters for (x)emacs and nano souliane <souliane@mailoo.org> parents: 1872 diff changeset	49 EMACS_SPLIT_ARGS = '--eval "(split-window-horizontally)"'
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	50 EDITOR_ARGS_MAGIC = {
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	51 'vim': VIM_SPLIT_ARGS + ' {content_file} {metadata_file}',
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	52 'gvim': VIM_SPLIT_ARGS + ' --nofork {content_file} {metadata_file}',
1873 6ec54626610c jp (blog): add to EDITOR_ARGS_MAGIC parameters for (x)emacs and nano souliane <souliane@mailoo.org> parents: 1872 diff changeset	53 'emacs': EMACS_SPLIT_ARGS + ' {content_file} {metadata_file}',
6ec54626610c jp (blog): add to EDITOR_ARGS_MAGIC parameters for (x)emacs and nano souliane <souliane@mailoo.org> parents: 1872 diff changeset	54 'xemacs': EMACS_SPLIT_ARGS + ' {content_file} {metadata_file}',
6ec54626610c jp (blog): add to EDITOR_ARGS_MAGIC parameters for (x)emacs and nano souliane <souliane@mailoo.org> parents: 1872 diff changeset	55 'nano': ' -F {content_file} {metadata_file}',
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	56 }
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	57
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	58 CONF_SYNTAX_EXT = 'syntax_ext_dict'
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	59 BLOG_TMP_DIR="blog"
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	60 METADATA_SUFF = '_metadata.json'
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	61 # key to remove from metadata tmp file if they exist
1912 c38bcc0343b6 jp (blog): added "updated" to keys to keys to remove from tmp metadata Goffi <goffi@goffi.org> parents: 1906 diff changeset	62 KEY_TO_REMOVE_METADATA = ('id','content', 'content_xhtml', 'comments_node', 'comments_service', 'updated')
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	63
1834 6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	64 URL_REDIRECT_PREFIX = 'url_redirect_'
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	65 INOTIFY_INSTALL = '"pip install inotify"'
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	66 SECURE_UNLINK_MAX = 10 * 2 # we double value has there are 2 files per draft (content and metadata)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	67 SECURE_UNLINK_DIR = ".backup"
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	68
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	69
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	70 class BlogCommon(object):
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	71
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	72 def __init__(self, host):
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	73 self.host = host
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	74
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	75 def getTmpDir(self, sat_conf, sub_dir=None):
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	76 """Return directory used to store temporary files
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	77
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	78 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	79 @param sub_dir(str): sub directory where data need to be put
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	80 profile can be used here, or special directory name
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	81 sub_dir will be escaped to be usable in path (use regex.pathUnescape to find
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	82 initial str)
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	83 @return (str): path to the dir
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	84 """
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	85 local_dir = config.getConfig(sat_conf, '', 'local_dir', Exception)
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	86 path = [local_dir, BLOG_TMP_DIR]
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	87 if sub_dir is not None:
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	88 path.append(regex.pathEscape(sub_dir))
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	89 return os.path.join(*path)
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	90
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	91 def getCurrentFile(self, sat_conf, profile):
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	92 """Get most recently edited file
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	93
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	94 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	95 @param profile(unicode): profile linked to the blog draft
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	96 @return(str): full path of current file
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	97 """
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	98 # we guess the blog item currently edited by choosing
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	99 # the most recent file corresponding to temp file pattern
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	100 # in tmp_dir, excluding metadata files
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	101 tmp_dir = self.getTmpDir(sat_conf, profile.encode('utf-8'))
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	102 available = [path for path in glob.glob(os.path.join(tmp_dir, 'blog_*')) if not path.endswith(METADATA_SUFF)]
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	103 if not available:
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	104 self.disp(u"Counldn't find any content draft in {path}".format(path=tmp_dir), error=True)
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	105 self.host.quit(1)
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	106 return max(available, key=lambda path: os.stat(path).st_mtime)
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	107
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	108 def secureUnlink(self, sat_conf, path):
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	109 """Unlink given path after keeping it for a while
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	110
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	111 This method is used to prevent accidental deletion of a blog draft
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	112 If there are more file in SECURE_UNLINK_DIR than SECURE_UNLINK_MAX,
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	113 older file are deleted
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	114 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	115 @param path(str): file to unlink
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	116 """
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	117 if not os.path.isfile(path):
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	118 raise OSError(u"path must link to a regular file")
1926 55a7328fafb6 jp (blog/edit): do not remove files if they are not in the temporary dir hierarchy Goffi <goffi@goffi.org> parents: 1925 diff changeset	119 if not path.startswith(self.getTmpDir(sat_conf)):
55a7328fafb6 jp (blog/edit): do not remove files if they are not in the temporary dir hierarchy Goffi <goffi@goffi.org> parents: 1925 diff changeset	120 self.disp(u"File {} is not in blog temporary hierarchy, we do not remove it".format(path.decode('utf-8')), 2)
55a7328fafb6 jp (blog/edit): do not remove files if they are not in the temporary dir hierarchy Goffi <goffi@goffi.org> parents: 1925 diff changeset	121 return
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	122 backup_dir = self.getTmpDir(sat_conf, SECURE_UNLINK_DIR)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	123 if not os.path.exists(backup_dir):
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	124 os.makedirs(backup_dir)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	125 filename = os.path.basename(path)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	126 backup_path = os.path.join(backup_dir, filename)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	127 # we move file to backup dir
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	128 self.host.disp(u"Backuping file {src} to {dst}".format(
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	129 src=path.decode('utf-8'), dst=backup_path.decode('utf-8')), 1)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	130 os.rename(path, backup_path)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	131 # and if we exceeded the limit, we remove older file
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	132 backup_files = [os.path.join(backup_dir, f) for f in os.listdir(backup_dir)]
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	133 if len(backup_files) > SECURE_UNLINK_MAX:
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	134 backup_files.sort(key=lambda path: os.stat(path).st_mtime)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	135 for path in backup_files[:len(backup_files) - SECURE_UNLINK_MAX]:
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	136 self.host.disp(u"Purging backup file {}".format(path.decode('utf-8')), 2)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	137 os.unlink(path)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	138
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	139 def guessSyntaxFromPath(self, sat_conf, path):
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	140 """Return syntax guessed according to filename extension
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	141
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	142 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	143 @param path(str): path to the content file
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	144 @return(unicode): syntax to use
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	145 """
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	146 # we first try to guess syntax with extension
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	147 ext = os.path.splitext(path)[1][1:] # we get extension without the '.'
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	148 if ext:
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	149 for k,v in SYNTAX_EXT.iteritems():
1968 eca59bc4e6c6 jp (blog): fixed syntax detection when extension is .txt Goffi <goffi@goffi.org> parents: 1929 diff changeset	150 if k and ext == v:
1883 abb2f253188e jp (blog): fixed syntax guessing on existing files Goffi <goffi@goffi.org> parents: 1882 diff changeset	151 return k
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	152
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	153 # if not found, we use current syntax
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	154 return self.host.bridge.getParamA("Syntax", "Composition", "value", self.profile)
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	155
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	156 def parse_args(self, cmd_line, **format_kw):
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	157 """Parse command arguments
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	158
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	159 @param cmd_line(unicode): command line as found in sat.conf
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	160 @param format_kw: keywords used for formmating
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	161 @return (list(unicode)): list of arguments to pass to subprocess function
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	162 """
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	163 try:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	164 # we split the arguments and add the known fields
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	165 # we split arguments first to avoid escaping issues in file names
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	166 return [a.format(**format_kw) for a in shlex.split(cmd_line)]
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	167 except ValueError as e:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	168 self.disp(u"Couldn't parse editor cmd [{cmd}]: {reason}".format(cmd=cmd_line, reason=e))
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	169 return []
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	170
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	171
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	172 class Edit(base.CommandBase, BlogCommon):
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	173
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	174 def __init__(self, host):
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	175 base.CommandBase.__init__(self, host, 'edit', use_verbose=True, help=_(u'edit an existing or new blog post'))
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	176 BlogCommon.__init__(self, self.host)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	177
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	178 def add_parser_options(self):
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	179 self.parser.add_argument("item", type=base.unicode_decoder, nargs='?', default=u'new', help=_(u"URL of the item to edit, or keyword"))
1887 16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	180 self.parser.add_argument("-P", "--preview", action="store_true", help=_(u"launch a blog preview in parallel"))
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	181 self.parser.add_argument("-T", '--title', type=base.unicode_decoder, help=_(u"title of the item"))
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	182 self.parser.add_argument("-t", '--tag', type=base.unicode_decoder, action='append', help=_(u"tag (category) of your item"))
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	183 self.parser.add_argument("--no-comment", action='store_true', help=_(u"disable comments"))
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	184
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	185 def getTmpFile(self, sat_conf, tmp_suff):
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	186 """Create a temporary file to received blog item body
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	187
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	188 @param sat_conf(ConfigParser.ConfigParser): instance opened on sat configuration
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	189 @param tmp_suff (str): suffix to use for the filename
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	190 @return (tuple(file, str)): opened (w+b) file object and file path
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	191 """
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	192 tmp_dir = self.getTmpDir(sat_conf, self.profile.encode('utf-8'))
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	193 if not os.path.exists(tmp_dir):
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	194 try:
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	195 os.makedirs(tmp_dir)
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	196 except OSError as e:
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	197 self.disp(u"Can't create {path} directory: {reason}".format(
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	198 path=tmp_dir, reason=e), error=True)
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	199 self.host.quit(1)
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	200 try:
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	201 fd, path = tempfile.mkstemp(suffix=tmp_suff,
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	202 prefix=time.strftime('blog_%Y-%m-%d_%H:%M:%S_'),
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	203 dir=tmp_dir, text=True)
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	204 return os.fdopen(fd, 'w+b'), path
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	205 except OSError as e:
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	206 self.disp(u"Can't create temporary file: {reason}".format(reason=e), error=True)
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	207 self.host.quit(1)
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	208
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	209 def buildMetadataFile(self, content_file_path, mb_data=None):
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	210 """Build a metadata file using json
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	211
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	212 The file is named after content_file_path, with extension replaced by _metadata.json
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	213 @param content_file_path(str): path to the temporary file which will contain the body
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	214 @param mb_data(dict, None): microblog metadata (for existing items)
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	215 @return (tuple[dict, str]): merged metadata put originaly in metadata file
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	216 and path to temporary metadata file
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	217 """
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	218 # we first construct metadata from edited item ones and CLI argumments
1876 1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	219 # or re-use the existing one if it exists
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	220 meta_file_path = os.path.splitext(content_file_path)[0] + METADATA_SUFF
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	221 if os.path.exists(meta_file_path):
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	222 self.disp(u"Metadata file already exists, we re-use it")
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	223 try:
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	224 with open(meta_file_path, 'rb') as f:
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	225 mb_data = json.load(f)
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	226 except (OSError, IOError, ValueError) as e:
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	227 self.disp(u"Can't read existing metadata file at {path}, aborting: {reason}".format(
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	228 path=meta_file_path, reason=e), error=True)
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	229 self.host.quit(1)
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	230 else:
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	231 mb_data = {} if mb_data is None else mb_data.copy()
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	232
1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	233 # in all cases, we want to remove unwanted keys
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	234 for key in KEY_TO_REMOVE_METADATA:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	235 try:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	236 del mb_data[key]
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	237 except KeyError:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	238 pass
1876 1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	239 # and override metadata with command-line arguments
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	240 mb_data['allow_comments'] = C.boolConst(not self.args.no_comment)
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	241 if self.args.tag:
1923 e28c6c4dffa5 jp (blog): avoid conflict error when command line tags are already present in metadata Goffi <goffi@goffi.org> parents: 1921 diff changeset	242 data_format.iter2dict('tag', self.args.tag, mb_data, check_conflict=False)
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	243 if self.args.title is not None:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	244 mb_data['title'] = self.args.title
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	245
1876 1088bf7b28e7 jp (blog/edit): metadata file is reused if it already exists Goffi <goffi@goffi.org> parents: 1874 diff changeset	246 # then we create the file and write metadata there, as JSON dict
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	247 # XXX: if we port jp one day on Windows, O_BINARY may need to be added here
1927 03f780b60d5d jp (blog/edit): added forgotten O_TRUNC while opening metadata file Goffi <goffi@goffi.org> parents: 1926 diff changeset	248 with os.fdopen(os.open(meta_file_path, os.O_RDWR \| os.O_CREAT \| os.O_TRUNC,0o600), 'w+b') as f:
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	249 # we need to use an intermediate unicode buffer to write to the file unicode without escaping characters
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	250 unicode_dump = json.dumps(mb_data, ensure_ascii=False, indent=4, separators=(',', ': '), sort_keys=True)
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	251 f.write(unicode_dump.encode('utf-8'))
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	252
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	253 return mb_data, meta_file_path
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	254
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	255 def edit(self, sat_conf, content_file_path, content_file_obj,
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	256 pubsub_service, pubsub_node, mb_data=None):
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	257 """Edit the file contening the content using editor, and publish it"""
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	258 item_ori_mb_data = mb_data
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	259 # we first create metadata file
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	260 meta_ori, meta_file_path = self.buildMetadataFile(content_file_path, item_ori_mb_data)
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	261
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	262 # then we calculate hashes to check for modifications
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	263 import hashlib
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	264 content_file_obj.seek(0)
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	265 tmp_ori_hash = hashlib.sha1(content_file_obj.read()).digest()
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	266 content_file_obj.close()
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	267
1887 16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	268 # do we need a preview ?
16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	269 if self.args.preview:
16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	270 self.disp(u"Preview requested, launching it", 1)
16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	271 # we redirect outputs to /dev/null to avoid console pollution in editor
16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	272 # if user wants to see messages, (s)he can call "blog preview" directly
16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	273 DEVNULL = open(os.devnull, 'wb')
1894 116a55865364 frontends (jp / blog): pass the profile to subprocess when using option --preview souliane <souliane@mailoo.org> parents: 1893 diff changeset	274 subprocess.Popen([sys.argv[0], "blog", "preview", "--inotify", "true", "-p", self.profile, content_file_path], stdout=DEVNULL, stderr=subprocess.STDOUT)
1887 16527dd5a81b blog (jp/edit): added --preview option to launch a "blog preview" in parallel Goffi <goffi@goffi.org> parents: 1886 diff changeset	275
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	276 # then we launch editor
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	277 editor = config.getConfig(sat_conf, 'jp', 'editor') or os.getenv('EDITOR', 'vi')
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	278 try:
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	279 # is there custom arguments in sat.conf ?
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	280 editor_args = config.getConfig(sat_conf, 'jp', 'blog_editor_args', Exception)
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	281 except (NoOptionError, NoSectionError):
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	282 # no, we check if we know the editor and have special arguments
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	283 editor_args = EDITOR_ARGS_MAGIC.get(os.path.basename(editor), '')
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	284 args = self.parse_args(editor_args, content_file=content_file_path, metadata_file=meta_file_path)
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	285 if not args:
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	286 args = [content_file_path]
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	287 editor_exit = subprocess.call([editor] + args)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	288
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	289 # we send the file if edition was a success
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	290 if editor_exit != 0:
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	291 self.disp(u"Editor exited with an error code, so temporary file has not be deleted, and blog item is not published.\nTou can find temporary file at {path}".format(
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	292 path=content_file_path), error=True)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	293 else:
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	294 try:
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	295 with open(content_file_path, 'rb') as f:
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	296 content = f.read()
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	297 with open(meta_file_path, 'rb') as f:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	298 mb_data = json.load(f)
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	299 except (OSError, IOError):
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	300 self.disp(u"Can read files at {content_path} and/or {meta_path}, have they been deleted?\nCancelling edition".format(
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	301 content_path=content_file_path, meta_path=meta_file_path), error=True)
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	302 self.host.quit(1)
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	303 except ValueError:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	304 self.disp(u"Can't parse metadata, please check it is correct JSON format. Cancelling edition.\n" +
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	305 "You can find tmp file at {content_path} and temporary meta file at {meta_path}.".format(
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	306 content_path=content_file_path, meta_path=meta_file_path), error=True)
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	307 self.host.quit(1)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	308
1870 c25077c87b1d base (blog/edit): added a way to block publishing by adding "publish": "false" in metadata file Goffi <goffi@goffi.org> parents: 1868 diff changeset	309 if not C.bool(mb_data.get('publish', "true")):
c25077c87b1d base (blog/edit): added a way to block publishing by adding "publish": "false" in metadata file Goffi <goffi@goffi.org> parents: 1868 diff changeset	310 self.disp(u'Publication blocked by "publish" key in metadata, cancelling edition.\n\n' +
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	311 "temporary file path:\t{content_path}\nmetadata file path:\t{meta_path}".format(
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	312 content_path=content_file_path, meta_path=meta_file_path), error=True)
1870 c25077c87b1d base (blog/edit): added a way to block publishing by adding "publish": "false" in metadata file Goffi <goffi@goffi.org> parents: 1868 diff changeset	313 self.host.quit(0)
c25077c87b1d base (blog/edit): added a way to block publishing by adding "publish": "false" in metadata file Goffi <goffi@goffi.org> parents: 1868 diff changeset	314
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	315 if len(content) == 0:
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	316 self.disp(u"Content is empty, cancelling the blog edition")
1926 55a7328fafb6 jp (blog/edit): do not remove files if they are not in the temporary dir hierarchy Goffi <goffi@goffi.org> parents: 1925 diff changeset	317 if not content_file_path.startswith(self.getTmpDir(sat_conf)):
55a7328fafb6 jp (blog/edit): do not remove files if they are not in the temporary dir hierarchy Goffi <goffi@goffi.org> parents: 1925 diff changeset	318 self.disp(u"File are not in blog temporary hierarchy, we do not remove it", 2)
55a7328fafb6 jp (blog/edit): do not remove files if they are not in the temporary dir hierarchy Goffi <goffi@goffi.org> parents: 1925 diff changeset	319 self.host.quit()
1924 70b1a29e1338 jp (blog): force deletion (without backup) when content is empty Goffi <goffi@goffi.org> parents: 1923 diff changeset	320 self.disp(u"Deletion of {}".format(content_file_path.decode('utf-8')), 2)
70b1a29e1338 jp (blog): force deletion (without backup) when content is empty Goffi <goffi@goffi.org> parents: 1923 diff changeset	321 os.unlink(content_file_path)
70b1a29e1338 jp (blog): force deletion (without backup) when content is empty Goffi <goffi@goffi.org> parents: 1923 diff changeset	322 self.disp(u"Deletion of {}".format(meta_file_path.decode('utf-8')), 2)
70b1a29e1338 jp (blog): force deletion (without backup) when content is empty Goffi <goffi@goffi.org> parents: 1923 diff changeset	323 os.unlink(meta_file_path)
70b1a29e1338 jp (blog): force deletion (without backup) when content is empty Goffi <goffi@goffi.org> parents: 1923 diff changeset	324 self.host.quit()
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	325
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	326 # time to re-check the hash
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	327 elif (tmp_ori_hash == hashlib.sha1(content).digest() and
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	328 meta_ori == mb_data):
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	329 self.disp(u"The content has not been modified, cancelling the blog edition")
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	330
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	331 else:
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	332 # we can now send the blog
1929 b603a3d516d3 jp (blog/edit): use utf-8-sig to decode content file to avoid BOM being propaged to content Goffi <goffi@goffi.org> parents: 1927 diff changeset	333 mb_data['content_rich'] = content.decode('utf-8-sig') # we use utf-8-sig to avoid BOM
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	334
1868 28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	335 if item_ori_mb_data is not None:
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	336 mb_data['id'] = item_ori_mb_data['id']
28b29381db75 jp (blog/edit): added metadata handling through a .json file (named like content temporary file, but with extension replaced by "_metadata.json"). Modification to this file before the end of edition will be taken into account. Goffi <goffi@goffi.org> parents: 1866 diff changeset	337
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	338 try:
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	339 self.host.bridge.mbSend(pubsub_service, pubsub_node, mb_data, self.profile)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	340 except Exception as e:
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	341 self.disp(u"Error while sending your blog, the temporary files have been kept at {content_path} and {meta_path}: {reason}".format(
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1871 diff changeset	342 content_path=content_file_path, meta_path=meta_file_path, reason=e), error=True)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	343 self.host.quit(1)
1888 7b9cdde29d8b jp (blog/edit): added a confirmation message when blog item has been successfuly published Goffi <goffi@goffi.org> parents: 1887 diff changeset	344 else:
7b9cdde29d8b jp (blog/edit): added a confirmation message when blog item has been successfuly published Goffi <goffi@goffi.org> parents: 1887 diff changeset	345 self.disp(u"Blog item published")
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	346
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	347 self.secureUnlink(sat_conf, content_file_path)
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	348 self.secureUnlink(sat_conf, meta_file_path)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	349
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	350 def start(self):
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	351 command = self.args.item.lower()
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	352 sat_conf = config.parseMainConf()
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	353 # if there are user defined extension, we use them
397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	354 SYNTAX_EXT.update(config.getConfig(sat_conf, 'jp', CONF_SYNTAX_EXT, {}))
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	355 current_syntax = None
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	356 pubsub_service = pubsub_node = ''
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	357 pubsub_item = None
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	358
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	359 if command not in ('new', 'last', 'current'):
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	360 # we have probably an URL, we try to parse it
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	361 import urlparse
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	362 url = self.args.item
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	363 parsed_url = urlparse.urlsplit(url)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	364 if parsed_url.scheme.startswith('http'):
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	365 self.disp(u"{} URL found, trying to find associated xmpp: URI".format(parsed_url.scheme.upper()),1)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	366 # HTTP URL, we try to find xmpp: links
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	367 try:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	368 from lxml import etree
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	369 except ImportError:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	370 self.disp(u"lxml module must be installed to use http(s) scheme, please install it with \"pip install lxml\"", error=True)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	371 self.host.quit(1)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	372 parser = etree.HTMLParser()
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	373 root = etree.parse(url, parser)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	374 links = root.xpath("//link[@rel='alternate' and starts-with(@href, 'xmpp:')]")
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	375 if not links:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	376 self.disp(u'Could not find alternate "xmpp:" URI, can\'t find associated XMPP PubSub node/item', error=True)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	377 self.host.quit(1)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	378 url = links[0].get('href')
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	379 parsed_url = urlparse.urlsplit(url)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	380
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	381 if parsed_url.scheme == 'xmpp':
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	382 self.disp(u"XMPP URI used: {}".format(url),2)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	383 # XXX: if we have not xmpp: URI here, we'll take the data as a file path
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	384 pubsub_service = parsed_url.path
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	385 pubsub_data = urlparse.parse_qs(parsed_url.query)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	386 try:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	387 pubsub_node = pubsub_data['node'][0]
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	388 except KeyError:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	389 self.disp(u'No node found in xmpp: URI, can\'t retrieve item', error=True)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	390 self.host.quit(1)
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	391 pubsub_item = pubsub_data.get('item',[None])[0]
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	392 if pubsub_item is not None:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	393 command = 'edit' # XXX: edit command is only used internaly, it similar to last, but with the item given in the URL
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	394 else:
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	395 command = 'new'
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	396
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	397 if command in ('new', 'last', 'edit'):
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	398 # we get current syntax to determine file extension
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	399 current_syntax = self.host.bridge.getParamA("Syntax", "Composition", "value", self.profile)
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	400 # we now create a temporary file
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	401 tmp_suff = '.' + SYNTAX_EXT.get(current_syntax, SYNTAX_EXT[''])
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	402 content_file_obj, content_file_path = self.getTmpFile(sat_conf, tmp_suff)
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	403 if command == 'new':
1905 e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	404 self.disp(u'Editing a new blog item', 2)
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	405 mb_data = None
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	406 elif command in ('last', 'edit'):
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	407 self.disp(u'Editing requested published item', 2)
1905 e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	408 try:
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	409 items_ids = [pubsub_item] if pubsub_item is not None else []
53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	410 mb_data = self.host.bridge.mbGet(pubsub_service, pubsub_node, 1, items_ids, {}, self.profile)[0][0]
1905 e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	411 except Exception as e:
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	412 self.disp(u"Error while retrieving last item: {}".format(e))
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	413 self.host.quit(1)
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	414
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	415 content = mb_data['content_xhtml']
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	416 if content and current_syntax != 'XHTML':
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	417 content = self.host.bridge.syntaxConvert(content, 'XHTML', current_syntax, False, self.profile)
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	418 content_file_obj.write(content.encode('utf-8'))
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	419 content_file_obj.seek(0)
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	420 else:
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	421 mb_data = None
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	422 if command == 'current':
1905 e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	423 # use wants to continue current draft
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	424 content_file_path = self.getCurrentFile(sat_conf, self.profile)
1905 e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	425 self.disp(u'Continuing edition of current draft', 2)
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	426 else:
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	427 # we consider the item as a file path
1905 e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	428 content_file_path = os.path.expanduser(self.args.item)
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	429 content_file_obj = open(content_file_path, 'r+b')
e0bfdd379e8d jp (blog/edit): a draft file can be directly specified Goffi <goffi@goffi.org> parents: 1904 diff changeset	430 current_syntax = self.guessSyntaxFromPath(sat_conf, content_file_path)
1866 397ef87958b9 jp (blog): edit command, first draft: Goffi <goffi@goffi.org> parents: 1864 diff changeset	431
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	432 self.disp(u"Syntax used: {}".format(current_syntax), 1)
1925 53b51866747f jp (blog/edit): HTTP(S) and XMPP URLs can now be directly used in blog/edit command Goffi <goffi@goffi.org> parents: 1924 diff changeset	433 self.edit(sat_conf, content_file_path, content_file_obj, pubsub_service, pubsub_node, mb_data=mb_data)
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	434
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	435
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	436 class Preview(base.CommandBase, BlogCommon):
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	437
658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	438 def __init__(self, host):
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	439 base.CommandBase.__init__(self, host, 'preview', use_verbose=True, help=_(u'preview a blog content'))
b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	440 BlogCommon.__init__(self, self.host)
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	441
658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	442 def add_parser_options(self):
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	443 self.parser.add_argument("--inotify", type=str, choices=('auto', 'true', 'false'), default=u'auto', help=_(u"use inotify to handle preview"))
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	444 self.parser.add_argument("file", type=base.unicode_decoder, nargs='?', default=u'current', help=_(u"path to the content file"))
658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	445
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	446 def showPreview(self):
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	447 # we implement showPreview here so we don't have to import webbroser and urllib
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	448 # when preview is not used
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	449 url = 'file:{}'.format(self.urllib.quote(self.preview_file_path))
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	450 self.webbrowser.open_new_tab(url)
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	451
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	452 def _launchPreviewExt(self, cmd_line, opt_name):
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	453 url = 'file:{}'.format(self.urllib.quote(self.preview_file_path))
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	454 args = self.parse_args(cmd_line, url=url, preview_file=self.preview_file_path)
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	455 if not args:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	456 self.disp(u"Couln't find command in \"{name}\", abording".format(name=opt_name), error=True)
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	457 self.host.quit(1)
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	458 subprocess.Popen(args)
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	459
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	460 def openPreviewExt(self):
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	461 self._launchPreviewExt(self.open_cb_cmd, "blog_preview_open_cmd")
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	462
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	463 def updatePreviewExt(self):
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	464 self._launchPreviewExt(self.update_cb_cmd, "blog_preview_update_cmd")
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	465
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	466 def updateContent(self):
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	467 with open(self.content_file_path, 'rb') as f:
1929 b603a3d516d3 jp (blog/edit): use utf-8-sig to decode content file to avoid BOM being propaged to content Goffi <goffi@goffi.org> parents: 1927 diff changeset	468 content = f.read().decode('utf-8-sig')
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	469 if content and self.syntax != 'XHTML':
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	470 # we use safe=True because we want to have a preview as close as possible to what the
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	471 # people will see
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	472 content = self.host.bridge.syntaxConvert(content, self.syntax, 'XHTML', True, self.profile)
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	473
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	474 xhtml = (u'<html xmlns="http://www.w3.org/1999/xhtml">' +
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	475 u'<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8" /></head>'+
a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	476 '<body>{}</body>' +
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	477 u'</html>').format(content)
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	478
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	479 with open(self.preview_file_path, 'wb') as f:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	480 f.write(xhtml.encode('utf-8'))
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	481
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	482 def start(self):
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	483 import webbrowser
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	484 import urllib
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	485 self.webbrowser, self.urllib = webbrowser, urllib
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	486
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	487 if self.args.inotify != 'false':
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	488 try:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	489 import inotify.adapters
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	490 import inotify.constants
1886 f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	491 from inotify.calls import InotifyError
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	492 except ImportError:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	493 if self.args.inotify == 'auto':
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	494 inotify = None
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	495 self.disp(u'inotify module not found, deactivating feature. You can install it with {install}'.format(install=INOTIFY_INSTALL))
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	496 else:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	497 self.disp(u"inotify not found, can't activate the feature! Please install it with {install}".format(install=INOTIFY_INSTALL), error=True)
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	498 self.host.quit(1)
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	499 else:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	500 # we deactivate logging in inotify, which is quite annoying
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	501 try:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	502 inotify.adapters._LOGGER.setLevel(40)
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	503 except AttributeError:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	504 self.disp(u"Logger doesn't exists, inotify may have chanded", error=True)
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	505 else:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	506 inotify=None
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	507
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	508 sat_conf = config.parseMainConf()
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	509 SYNTAX_EXT.update(config.getConfig(sat_conf, 'jp', CONF_SYNTAX_EXT, {}))
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	510
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	511 try:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	512 self.open_cb_cmd = config.getConfig(sat_conf, 'jp', "blog_preview_open_cmd", Exception)
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	513 except (NoOptionError, NoSectionError):
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	514 self.open_cb_cmd = None
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	515 open_cb = self.showPreview
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	516 else:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	517 open_cb = self.openPreviewExt
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	518
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	519 self.update_cb_cmd = config.getConfig(sat_conf, 'jp', "blog_preview_update_cmd", self.open_cb_cmd)
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	520 if self.update_cb_cmd is None:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	521 update_cb = self.showPreview
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	522 else:
edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	523 update_cb = self.updatePreviewExt
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	524
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	525 # which file do we need to edit?
658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	526 if self.args.file == 'current':
1921 b111f6589da4 jp (blog): drafts are now put in a sub dir per profile + added a security which keep the last 10 drafts before removing them (all profiles included). Goffi <goffi@goffi.org> parents: 1919 diff changeset	527 self.content_file_path = self.getCurrentFile(sat_conf, self.profile)
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	528 else:
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	529 self.content_file_path = os.path.abspath(self.args.file)
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	530
1885 edd8dc8df1b9 jp (blog/preview): open and preview commands can be changed in sat.conf with "blog_preview_open_cmd" and "blog_preview_update_cmd" in [jp] section + don't convert syntax when content is empty Goffi <goffi@goffi.org> parents: 1883 diff changeset	531 self.syntax = self.guessSyntaxFromPath(sat_conf, self.content_file_path)
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	532
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	533
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	534 # at this point the syntax is converted, we can display the preview
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	535 preview_file = tempfile.NamedTemporaryFile(suffix='.xhtml', delete=False)
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	536 self.preview_file_path = preview_file.name
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	537 preview_file.close()
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	538 self.updateContent()
1877 a97db84c048d jp (blog): moved common method in a BlogCommon class + added "current" as an item keyword for blog/edit Goffi <goffi@goffi.org> parents: 1876 diff changeset	539
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	540 if inotify is None:
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	541 # XXX: we don't delete file automatically because browser need it (and webbrowser.open can return before it is read)
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	542 self.disp(u'temporary file created at {}\nthis file will NOT BE DELETED AUTOMATICALLY, please delete it yourself when you have finished'.format(self.preview_file_path))
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	543 open_cb()
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	544 else:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	545 open_cb()
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	546 i = inotify.adapters.Inotify(block_duration_s=60) # no need for 1 s duraction, inotify drive actions here
1886 f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	547
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	548 def add_watch():
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	549 i.add_watch(self.content_file_path, mask=inotify.constants.IN_CLOSE_WRITE \|
1893 4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	550 inotify.constants.IN_DELETE_SELF \|
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	551 inotify.constants.IN_MOVE_SELF)
1886 f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	552 add_watch()
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	553
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	554 try:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	555 for event in i.event_gen():
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	556 if event is not None:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	557 self.disp(u"Content updated", 1)
1893 4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	558 if {"IN_DELETE_SELF", "IN_MOVE_SELF"}.intersection(event[1]):
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	559 self.disp(u"{} event catched, changing the watch".format(", ".join(event[1])), 2)
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	560 try:
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	561 add_watch()
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	562 except InotifyError:
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	563 # if the new file is not here yet we can have an error
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	564 # as a workaround, we do a little rest
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	565 time.sleep(1)
4f252b72b193 jp (blog/preview): change watch for IN_MOVE_SELF event, needed at least for Emacs Goffi <goffi@goffi.org> parents: 1888 diff changeset	566 add_watch()
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	567 self.updateContent()
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	568 update_cb()
1886 f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	569 except InotifyError:
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	570 self.disp(u"Can't catch inotify events, as the file been deleted?", error=True)
1882 ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	571 finally:
ed444e9aa078 jp (blog/preview): added inotify support, so preview can be updated each time the file is modified (actually IN_CLOSE_WRITE is used, but this may change in the future) Goffi <goffi@goffi.org> parents: 1881 diff changeset	572 os.unlink(self.preview_file_path)
1886 f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	573 try:
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	574 i.remove_watch(self.content_file_path)
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	575 except InotifyError:
f3db27508b31 jp (blog/preview): inotify improvments: Goffi <goffi@goffi.org> parents: 1885 diff changeset	576 pass
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	577
658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	578
1840 9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined souliane <souliane@mailoo.org> parents: 1839 diff changeset	579 class Import(base.CommandAnswering):
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	580 def __init__(self, host):
1834 6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	581 super(Import, self).__init__(host, 'import', use_progress=True, help=_(u'import an external blog'))
1864 96ba685162f6 jp: all commands now use the new start method and set need_loop in __init__ when needed Goffi <goffi@goffi.org> parents: 1840 diff changeset	582 self.need_loop=True
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	583
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	584 def add_parser_options(self):
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	585 self.parser.add_argument("importer", type=base.unicode_decoder, nargs='?', help=_(u"importer name, nothing to display importers list"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	586 self.parser.add_argument('--host', type=base.unicode_decoder, help=_(u"original blog host"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	587 self.parser.add_argument('--no-images-upload', action='store_true', help=_(u"do NOT upload images (default: do upload images)"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	588 self.parser.add_argument('--upload-ignore-host', help=_(u"do not upload images from this host (default: upload all images)"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	589 self.parser.add_argument("--ignore-tls-errors", action="store_true", help=_("ignore invalide TLS certificate for uploads"))
1839 cdecf553e051 frontends (jp/blog), plugin blog_import: fixes: souliane <souliane@mailoo.org> parents: 1834 diff changeset	590 self.parser.add_argument('-o', '--option', action='append', nargs=2, default=[], metavar=(u'NAME', u'VALUE'),
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	591 help=_(u"importer specific options (see importer description)"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	592 self.parser.add_argument('--service', type=base.unicode_decoder, default=u'', metavar=u'PUBSUB_SERVICE',
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	593 help=_(u"PubSub service where the items must be uploaded (default: server)"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	594 self.parser.add_argument("location", type=base.unicode_decoder, nargs='?',
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	595 help=_(u"importer data location (see importer description), nothing to show importer description"))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	596
1834 6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	597 def onProgressStarted(self, metadata):
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	598 self.disp(_(u'Blog upload started'),2)
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	599
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	600 def onProgressFinished(self, metadata):
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	601 self.disp(_(u'Blog uploaded successfully'),2)
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	602 redirections = {k[len(URL_REDIRECT_PREFIX):]:v for k,v in metadata.iteritems()
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	603 if k.startswith(URL_REDIRECT_PREFIX)}
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	604 if redirections:
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	605 conf = u'\n'.join([
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	606 u'url_redirections_profile = {}'.format(self.profile),
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	607 u"url_redirections_dict = {}".format(
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	608 # we need to add ' ' before each new line and to double each '%' for ConfigParser
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	609 u'\n '.join(json.dumps(redirections, indent=1, separators=(',',': ')).replace(u'%', u'%%').split(u'\n'))),
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	610 ])
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	611 self.disp(_(u'\nTo redirect old URLs to new ones, put the following lines in your sat.conf file, in [libervia] section:\n\n{conf}'.format(conf=conf)))
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	612
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	613 def onProgressError(self, error_msg):
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	614 self.disp(_(u'Error while uploading blog: {}').format(error_msg),error=True)
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	615
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	616 def error(self, failure):
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	617 self.disp(_("Error while trying to upload a blog: {reason}").format(reason=failure), error=True)
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	618 self.host.quit(1)
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	619
1864 96ba685162f6 jp: all commands now use the new start method and set need_loop in __init__ when needed Goffi <goffi@goffi.org> parents: 1840 diff changeset	620 def start(self):
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	621 if self.args.location is None:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	622 for name in ('option', 'service', 'no_images_upload'):
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	623 if getattr(self.args, name):
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	624 self.parser.error(_(u"{name} argument can't be used without location argument").format(name=name))
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	625 if self.args.importer is None:
1839 cdecf553e051 frontends (jp/blog), plugin blog_import: fixes: souliane <souliane@mailoo.org> parents: 1834 diff changeset	626 print u'\n'.join([u'{}: {}'.format(name, desc) for name, desc in self.host.bridge.blogImportList()])
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	627 else:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	628 try:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	629 short_desc, long_desc = self.host.bridge.blogImportDesc(self.args.importer)
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	630 except Exception as e:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	631 msg = [l for l in unicode(e).split('\n') if l][-1] # we only keep the last line
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	632 print msg
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	633 self.host.quit(1)
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	634 else:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	635 print u"{name}: {short_desc}\n\n{long_desc}".format(name=self.args.importer, short_desc=short_desc, long_desc=long_desc)
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	636 self.host.quit()
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	637 else:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	638 # we have a location, an import is requested
1839 cdecf553e051 frontends (jp/blog), plugin blog_import: fixes: souliane <souliane@mailoo.org> parents: 1834 diff changeset	639 options = {key: value for key, value in self.args.option}
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	640 if self.args.host:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	641 options['host'] = self.args.host
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	642 if self.args.ignore_tls_errors:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	643 options['ignore_tls_errors'] = C.BOOL_TRUE
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	644 if self.args.no_images_upload:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	645 options['upload_images'] = C.BOOL_FALSE
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	646 if self.args.upload_ignore_host:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	647 self.parser.error(u"upload-ignore-host option can't be used when no-images-upload is set")
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	648 elif self.args.upload_ignore_host:
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	649 options['upload_ignore_host'] = self.args.upload_ignore_host
1834 6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	650 def gotId(id_):
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	651 self.progress_id = id_
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	652 self.host.bridge.blogImport(self.args.importer, self.args.location, options, self.args.service, self.profile,
6209de5e3e25 jp (blog): import now show progression + value to add to sat.conf for URLs redirection Goffi <goffi@goffi.org> parents: 1827 diff changeset	653 callback=gotId, errback=self.error)
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	654
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	655
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	656 class Blog(base.CommandBase):
1874 658824755a0c jp (blog): preview command, first draft Goffi <goffi@goffi.org> parents: 1873 diff changeset	657 subcommands = (Edit, Preview, Import)
1827 74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	658
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	659 def __init__(self, host):
74014a9cc203 jp: added a blog/import command to handle new blog import plugin Goffi <goffi@goffi.org> parents: diff changeset	660 super(Blog, self).__init__(host, 'blog', use_profile=False, help=_('blog/microblog management'))

Mercurial > libervia-backend

annotate frontends/src/jp/cmd_blog.py @ 2023:224c8b0886bc