201 lines
6.6 KiB
Python
201 lines
6.6 KiB
Python
import os
|
|
import shutil
|
|
import subprocess
|
|
import collections
|
|
|
|
from ... import repo
|
|
from ... import files
|
|
from ...configs import config
|
|
from ...uis import get_ui
|
|
from ...plugins import PapersPlugin
|
|
from ...commands.helpers import add_references_argument, parse_reference
|
|
|
|
from ...events import RemoveEvent, RenameEvent, AddEvent
|
|
|
|
SECTION = 'texnote'
|
|
DIR = os.path.join(config().papers_dir, 'texnote')
|
|
TPL_DIR = os.path.join(DIR, 'template')
|
|
TPL_BODY = os.path.join(TPL_DIR, 'body.tex')
|
|
TPL_STYLE = os.path.join(TPL_DIR, 'style.sty')
|
|
|
|
DFT_BODY = os.path.join(os.path.dirname(__file__), 'default_body.tex')
|
|
DFT_STYLE = os.path.join(os.path.dirname(__file__), 'default_style.sty')
|
|
|
|
|
|
class TexnotePlugin(PapersPlugin):
|
|
|
|
def __init__(self):
|
|
self.name = SECTION
|
|
|
|
self.texcmds = collections.OrderedDict([
|
|
('remove', self.remove),
|
|
('edit', self.edit),
|
|
('edit_template', self.edit_template),
|
|
])
|
|
|
|
def _ensure_init(self):
|
|
if not files.check_directory(DIR):
|
|
os.mkdir(DIR)
|
|
if not files.check_directory(TPL_DIR):
|
|
os.mkdir(TPL_DIR)
|
|
if not files.check_file(TPL_BODY):
|
|
shutil.copy(DFT_BODY, TPL_BODY)
|
|
if not files.check_file(TPL_STYLE):
|
|
shutil.copy(DFT_STYLE, TPL_STYLE)
|
|
|
|
def parser(self, subparsers):
|
|
parser = subparsers.add_parser(self.name, help='edit advance note in latex')
|
|
sub = parser.add_subparsers(title='valid texnote commands', dest='texcmd')
|
|
# remove
|
|
p = sub.add_parser('remove', help='remove a reference')
|
|
add_references_argument(p, single=True)
|
|
# edit
|
|
p = sub.add_parser('edit', help='edit the reference texnote')
|
|
p.add_argument('-v', '--view', action='store_true',
|
|
help='open the paper in a pdf viewer', default=None)
|
|
p.add_argument('-w', '--with', dest='with_command', default=None,
|
|
help='command to use to open the file')
|
|
add_references_argument(p, single=True)
|
|
#edit_template
|
|
p = sub.add_parser('edit_template', help='edit the latex template used by texnote')
|
|
p.add_argument('-w', '--with', dest='with_command', default=None,
|
|
help='command to use to open the file')
|
|
p.add_argument('-B', '--body', action='store_true',
|
|
help='edit the main body', default=None)
|
|
p.add_argument('-S', '--style', action='store_true',
|
|
help='open the style', default=None)
|
|
return parser
|
|
|
|
def command(self, args):
|
|
self._ensure_init()
|
|
|
|
texcmd = args.texcmd
|
|
del args.texcmd
|
|
self.texcmds[texcmd](**vars(args))
|
|
|
|
def _texfile(self, citekey):
|
|
return os.path.join(DIR, citekey + '.tex')
|
|
|
|
def _ensure_texfile(self, citekey):
|
|
if not files.check_file(self._texfile(citekey)):
|
|
shutil.copy(TPL_BODY, self._texfile(citekey))
|
|
|
|
def _autofill_texfile(self, citekey):
|
|
self._ensure_texfile(citekey)
|
|
with open(self._texfile(citekey)) as f:
|
|
text = f.read()
|
|
rp = repo.Repository(config())
|
|
if citekey in rp:
|
|
paper = rp.get_paper(citekey)
|
|
fields = paper.bibentry.fields
|
|
persons = paper.bibentry.persons
|
|
|
|
if 'title' in fields:
|
|
title_str = fields['title']
|
|
text = text.replace("TITLE", title_str)
|
|
|
|
if 'year' in fields:
|
|
year_str = fields['year']
|
|
text = text.replace("YEAR", year_str)
|
|
|
|
if 'abstract' in fields:
|
|
abstract_str = fields['abstract']
|
|
text = text.replace("ABSTRACT", abstract_str)
|
|
|
|
if 'author' in persons:
|
|
authors = []
|
|
for author in persons['author']:
|
|
authors.append(format_author(author))
|
|
author_str = concatenate_authors(authors)
|
|
text = text.replace("AUTHOR", author_str)
|
|
|
|
with open(self._texfile(citekey), "w") as f:
|
|
f.write(text)
|
|
|
|
def get_texfile(self, citekey):
|
|
""" This function returns the name of the texfile and
|
|
ensure it exist and it is filled with info from the bibfile if possible"""
|
|
self._autofill_texfile(citekey)
|
|
return self._texfile(citekey)
|
|
|
|
def get_edit_cmd(self):
|
|
default = config().edit_cmd
|
|
return config(SECTION).get('edit_cmd', default)
|
|
|
|
def edit(self, reference, view=None, with_command=None):
|
|
if view is not None:
|
|
subprocess.Popen(['papers', 'open', reference])
|
|
if with_command is None:
|
|
with_command = self.get_edit_cmd()
|
|
|
|
rp = repo.Repository(config())
|
|
citekey = parse_reference(rp, reference)
|
|
files.edit_file(with_command, self.get_texfile(citekey), temporary=False)
|
|
|
|
def edit_template(self, body=None, style=None, with_command=None):
|
|
if with_command is None:
|
|
with_command = self.get_edit_cmd()
|
|
if body is not None:
|
|
files.edit_file(with_command, TPL_BODY, temporary=False)
|
|
if style is not None:
|
|
files.edit_file(with_command, TPL_STYLE, temporary=False)
|
|
|
|
def create(self, citekey):
|
|
self._autofill_texfile(citekey)
|
|
|
|
def remove(self, reference):
|
|
rp = repo.Repository(config())
|
|
citekey = parse_reference(rp, reference)
|
|
os.remove(self.get_texfile(citekey))
|
|
|
|
def rename(self, old_citekey, new_citekey, overwrite=False):
|
|
shutil.move(self.get_texfile(old_citekey), self.get_texfile(new_citekey))
|
|
|
|
|
|
@AddEvent.listen()
|
|
def create(addevent):
|
|
texplug = TexnotePlugin.get_instance()
|
|
texplug.create(addevent.citekey)
|
|
|
|
|
|
@RemoveEvent.listen()
|
|
def remove(rmevent):
|
|
texplug = TexnotePlugin.get_instance()
|
|
texplug.remove(rmevent.citekey)
|
|
|
|
|
|
@RenameEvent.listen()
|
|
def rename(renamevent):
|
|
texplug = TexnotePlugin.get_instance()
|
|
texplug.rename(renamevent.old_citekey,
|
|
renamevent.paper.citekey,
|
|
overwrite=True)
|
|
|
|
|
|
##### ugly replace by proper #####
|
|
def format_author(author):
|
|
first = author.first()
|
|
middle = author.middle()
|
|
last = author.last()
|
|
formatted = ''
|
|
if first:
|
|
formatted += first[0]
|
|
if middle:
|
|
formatted += ' ' + middle[0] + '.'
|
|
if last:
|
|
formatted += ' ' + last[0]
|
|
return formatted
|
|
|
|
|
|
def concatenate_authors(authors):
|
|
concatenated = ''
|
|
for a in range(len(authors)):
|
|
if len(authors) > 1 and a > 0:
|
|
if a == len(authors) - 1:
|
|
concatenated += 'and '
|
|
else:
|
|
concatenated += ', '
|
|
concatenated += authors[a]
|
|
return concatenated
|
|
#####
|