diff options
Diffstat (limited to 'nikola/plugins/command/init.py')
| -rw-r--r-- | nikola/plugins/command/init.py | 346 |
1 files changed, 308 insertions, 38 deletions
diff --git a/nikola/plugins/command/init.py b/nikola/plugins/command/init.py index d7eeed7..8fb15e0 100644 --- a/nikola/plugins/command/init.py +++ b/nikola/plugins/command/init.py @@ -24,19 +24,24 @@ # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -from __future__ import print_function +from __future__ import print_function, unicode_literals import os import shutil import codecs import json - +import textwrap +import datetime +import unidecode +import dateutil.tz from mako.template import Template +from pkg_resources import resource_filename import nikola -from nikola.nikola import DEFAULT_TRANSLATIONS_PATTERN +from nikola.nikola import DEFAULT_TRANSLATIONS_PATTERN, DEFAULT_INDEX_READ_MORE_LINK, DEFAULT_RSS_READ_MORE_LINK, LEGAL_VALUES from nikola.plugin_categories import Command -from nikola.utils import get_logger, makedirs, STDERR_HANDLER -from nikola.winutils import fix_git_symlinked +from nikola.utils import ask, ask_yesno, get_logger, makedirs, STDERR_HANDLER, load_messages +from nikola.packages.tzlocal import get_localzone + LOGGER = get_logger('init', STDERR_HANDLER) @@ -47,39 +52,144 @@ SAMPLE_CONF = { 'BLOG_EMAIL': "joe@demo.site", 'BLOG_DESCRIPTION': "This is a demo site for Nikola.", 'DEFAULT_LANG': "en", + 'TRANSLATIONS': """{ + DEFAULT_LANG: "", + # Example for another language: + # "es": "./es", +}""", 'THEME': 'bootstrap3', + 'TIMEZONE': 'UTC', 'COMMENT_SYSTEM': 'disqus', 'COMMENT_SYSTEM_ID': 'nikolademo', 'TRANSLATIONS_PATTERN': DEFAULT_TRANSLATIONS_PATTERN, + 'INDEX_READ_MORE_LINK': DEFAULT_INDEX_READ_MORE_LINK, + 'RSS_READ_MORE_LINK': DEFAULT_RSS_READ_MORE_LINK, 'POSTS': """( -("posts/*.rst", "posts", "post.tmpl"), -("posts/*.txt", "posts", "post.tmpl"), + ("posts/*.rst", "posts", "post.tmpl"), + ("posts/*.txt", "posts", "post.tmpl"), )""", 'PAGES': """( -("stories/*.rst", "stories", "story.tmpl"), -("stories/*.txt", "stories", "story.tmpl"), + ("stories/*.rst", "stories", "story.tmpl"), + ("stories/*.txt", "stories", "story.tmpl"), )""", 'COMPILERS': """{ -"rest": ('.rst', '.txt'), -"markdown": ('.md', '.mdown', '.markdown'), -"textile": ('.textile',), -"txt2tags": ('.t2t',), -"bbcode": ('.bb',), -"wiki": ('.wiki',), -"ipynb": ('.ipynb',), -"html": ('.html', '.htm'), -# PHP files are rendered the usual way (i.e. with the full templates). -# The resulting files have .php extensions, making it possible to run -# them without reconfiguring your server to recognize them. -"php": ('.php',), -# Pandoc detects the input from the source filename -# but is disabled by default as it would conflict -# with many of the others. -# "pandoc": ('.rst', '.md', '.txt'), + "rest": ('.rst', '.txt'), + "markdown": ('.md', '.mdown', '.markdown'), + "textile": ('.textile',), + "txt2tags": ('.t2t',), + "bbcode": ('.bb',), + "wiki": ('.wiki',), + "ipynb": ('.ipynb',), + "html": ('.html', '.htm'), + # PHP files are rendered the usual way (i.e. with the full templates). + # The resulting files have .php extensions, making it possible to run + # them without reconfiguring your server to recognize them. + "php": ('.php',), + # Pandoc detects the input from the source filename + # but is disabled by default as it would conflict + # with many of the others. + # "pandoc": ('.rst', '.md', '.txt'), +}""", + 'NAVIGATION_LINKS': """{ + DEFAULT_LANG: ( + ("/archive.html", "Archives"), + ("/categories/index.html", "Tags"), + ("/rss.xml", "RSS feed"), + ), }""", 'REDIRECTIONS': [], } +# Generate a list of supported languages here. +# Ugly code follows. +_suplang = {} +_sllength = 0 + +for k, v in LEGAL_VALUES['TRANSLATIONS'].items(): + if not isinstance(k, tuple): + main = k + _suplang[main] = v + else: + main = k[0] + k = k[1:] + bad = [] + good = [] + for i in k: + if i.startswith('!'): + bad.append(i[1:]) + else: + good.append(i) + different = '' + if good or bad: + different += ' [' + if good: + different += 'ALTERNATIVELY ' + ', '.join(good) + if bad: + if good: + different += '; ' + different += 'NOT ' + ', '.join(bad) + if good or bad: + different += ']' + _suplang[main] = v + different + + if len(main) > _sllength: + _sllength = len(main) + +_sllength = str(_sllength) +suplang = (u'# {0:<' + _sllength + u'} {1}\n').format('en', 'English') +del _suplang['en'] +for k, v in sorted(_suplang.items()): + suplang += (u'# {0:<' + _sllength + u'} {1}\n').format(k, v) + +SAMPLE_CONF['_SUPPORTED_LANGUAGES'] = suplang.strip() + +# Generate a list of supported comment systems here. + +SAMPLE_CONF['_SUPPORTED_COMMENT_SYSTEMS'] = '\n'.join(textwrap.wrap( + u', '.join(LEGAL_VALUES['COMMENT_SYSTEM']), + initial_indent=u'# ', subsequent_indent=u'# ', width=79)) + + +def format_default_translations_config(additional_languages): + """Return the string to configure the TRANSLATIONS config variable to + make each additional language visible on the generated site.""" + if not additional_languages: + return SAMPLE_CONF["TRANSLATIONS"] + lang_paths = [' DEFAULT_LANG: "",'] + for lang in sorted(additional_languages): + lang_paths.append(' "{0}": "./{0}",'.format(lang)) + return "{{\n{0}\n}}".format("\n".join(lang_paths)) + + +def format_navigation_links(additional_languages, default_lang, messages): + """Return the string to configure NAVIGATION_LINKS.""" + f = u"""\ + {0}: ( + ("{1}/archive.html", "{2[Archive]}"), + ("{1}/categories/index.html", "{2[Tags]}"), + ("{1}/rss.xml", "{2[RSS feed]}"), + ),""" + + pairs = [] + + def get_msg(lang): + """Generate a smaller messages dict with fallback.""" + fmsg = {} + for i in (u'Archive', u'Tags', u'RSS feed'): + if messages[lang][i]: + fmsg[i] = messages[lang][i] + else: + fmsg[i] = i + return fmsg + + # handle the default language + pairs.append(f.format('DEFAULT_LANG', '', get_msg(default_lang))) + + for l in additional_languages: + pairs.append(f.format(json.dumps(l), '/' + l, get_msg(l))) + + return u'{{\n{0}\n}}'.format('\n\n'.join(pairs)) + # In order to ensure proper escaping, all variables but the three # pre-formatted ones are handled by json.dumps(). @@ -87,7 +197,10 @@ def prepare_config(config): """Parse sample config with JSON.""" p = config.copy() p.update(dict((k, json.dumps(v)) for k, v in p.items() - if k not in ('POSTS', 'PAGES', 'COMPILERS'))) + if k not in ('POSTS', 'PAGES', 'COMPILERS', 'TRANSLATIONS', 'NAVIGATION_LINKS', '_SUPPORTED_LANGUAGES', '_SUPPORTED_COMMENT_SYSTEMS', 'INDEX_READ_MORE_LINK', 'RSS_READ_MORE_LINK'))) + # READ_MORE_LINKs require some special treatment. + p['INDEX_READ_MORE_LINK'] = "'" + p['INDEX_READ_MORE_LINK'].replace("'", "\\'") + "'" + p['RSS_READ_MORE_LINK'] = "'" + p['RSS_READ_MORE_LINK'].replace("'", "\\'") + "'" return p @@ -97,13 +210,22 @@ class CommandInit(Command): name = "init" - doc_usage = "[--demo] folder" + doc_usage = "[--demo] [--quiet] folder" needs_config = False doc_purpose = "create a Nikola site in the specified folder" cmd_options = [ { + 'name': 'quiet', + 'long': 'quiet', + 'short': 'q', + 'default': False, + 'type': bool, + 'help': "Do not ask questions about config.", + }, + { 'name': 'demo', 'long': 'demo', + 'short': 'd', 'default': False, 'type': bool, 'help': "Create a site filled with example data.", @@ -112,15 +234,12 @@ class CommandInit(Command): @classmethod def copy_sample_site(cls, target): - lib_path = cls.get_path_to_nikola_modules() - src = os.path.join(lib_path, 'data', 'samplesite') + src = resource_filename('nikola', os.path.join('data', 'samplesite')) shutil.copytree(src, target) - fix_git_symlinked(src, target) @classmethod def create_configuration(cls, target): - lib_path = cls.get_path_to_nikola_modules() - template_path = os.path.join(lib_path, 'conf.py.in') + template_path = resource_filename('nikola', 'conf.py.in') conf_template = Template(filename=template_path) conf_path = os.path.join(target, 'conf.py') with codecs.open(conf_path, 'w+', 'utf8') as fd: @@ -132,16 +251,167 @@ class CommandInit(Command): makedirs(os.path.join(target, folder)) @staticmethod - def get_path_to_nikola_modules(): - return os.path.dirname(nikola.__file__) + def ask_questions(target): + """Ask some questions about Nikola.""" + def lhandler(default, toconf, show_header=True): + if show_header: + print("We will now ask you to provide the list of languages you want to use.") + print("Please list all the desired languages, comma-separated, using ISO 639-1 codes. The first language will be used as the default.") + print("Type '?' (a question mark, sans quotes) to list available languages.") + answer = ask('Language(s) to use', 'en') + while answer.strip() == '?': + print('\n# Available languages:') + try: + print(SAMPLE_CONF['_SUPPORTED_LANGUAGES'] + '\n') + except UnicodeEncodeError: + # avoid Unicode characters in supported language names + print(unidecode.unidecode(SAMPLE_CONF['_SUPPORTED_LANGUAGES']) + '\n') + answer = ask('Language(s) to use', 'en') + + langs = [i.strip().lower().replace('-', '_') for i in answer.split(',')] + for partial, full in LEGAL_VALUES['_TRANSLATIONS_WITH_COUNTRY_SPECIFIERS'].items(): + if partial in langs: + langs[langs.index(partial)] = full + print("NOTICE: Assuming '{0}' instead of '{1}'.".format(full, partial)) + + default = langs.pop(0) + SAMPLE_CONF['DEFAULT_LANG'] = default + # format_default_translations_config() is intelligent enough to + # return the current value if there are no additional languages. + SAMPLE_CONF['TRANSLATIONS'] = format_default_translations_config(langs) + + # Get messages for navigation_links. In order to do this, we need + # to generate a throwaway TRANSLATIONS dict. + tr = {default: ''} + for l in langs: + tr[l] = './' + l + # Assuming that base contains all the locales, and that base does + # not inherit from anywhere. + try: + messages = load_messages(['base'], tr, default) + SAMPLE_CONF['NAVIGATION_LINKS'] = format_navigation_links(langs, default, messages) + except nikola.utils.LanguageNotFoundError as e: + print(" ERROR: the language '{0}' is not supported.".format(e.lang)) + print(" Are you sure you spelled the name correctly? Names are case-sensitive and need to be reproduced as-is (complete with the country specifier, if any).") + print("\nType '?' (a question mark, sans quotes) to list available languages.") + lhandler(default, toconf, show_header=False) + + def tzhandler(default, toconf): + print("\nPlease choose the correct time zone for your blog. Nikola uses the tz database.") + print("You can find your time zone here:") + print("http://en.wikipedia.org/wiki/List_of_tz_database_time_zones") + print("") + answered = False + while not answered: + try: + lz = get_localzone() + except: + lz = None + answer = ask('Time zone', lz if lz else "UTC") + tz = dateutil.tz.gettz(answer) + if tz is not None: + time = datetime.datetime.now(tz).strftime('%H:%M:%S') + print(" Current time in {0}: {1}".format(answer, time)) + answered = ask_yesno("Use this time zone?", True) + else: + print(" ERROR: Time zone not found. Please try again. Time zones are case-sensitive.") + + SAMPLE_CONF['TIMEZONE'] = answer + + def chandler(default, toconf): + print("You can configure comments now. Type '?' (a question mark, sans quotes) to list available comment systems. If you do not want any comments, just leave the field blank.") + answer = ask('Comment system', '') + while answer.strip() == '?': + print('\n# Available comment systems:') + print(SAMPLE_CONF['_SUPPORTED_COMMENT_SYSTEMS']) + print('') + answer = ask('Comment system', '') + + while answer and answer not in LEGAL_VALUES['COMMENT_SYSTEM']: + if answer != '?': + print(' ERROR: Nikola does not know this comment system.') + print('\n# Available comment systems:') + print(SAMPLE_CONF['_SUPPORTED_COMMENT_SYSTEMS']) + print('') + answer = ask('Comment system', '') + + SAMPLE_CONF['COMMENT_SYSTEM'] = answer + SAMPLE_CONF['COMMENT_SYSTEM_ID'] = '' + + if answer: + print("You need to provide the site identifier for your comment system. Consult the Nikola manual for details on what the value should be. (you can leave it empty and come back later)") + answer = ask('Comment system site identifier', '') + SAMPLE_CONF['COMMENT_SYSTEM_ID'] = answer + + STORAGE = {'target': target} + + questions = [ + ('Questions about the site', None, None, None), + # query, default, toconf, destination + ('Destination', None, False, '!target'), + ('Site title', 'My Nikola Site', True, 'BLOG_TITLE'), + ('Site author', 'Nikola Tesla', True, 'BLOG_AUTHOR'), + ('Site author\'s e-mail', 'n.tesla@example.com', True, 'BLOG_EMAIL'), + ('Site description', 'This is a demo site for Nikola.', True, 'BLOG_DESCRIPTION'), + ('Site URL', 'http://getnikola.com/', True, 'SITE_URL'), + ('Questions about languages and locales', None, None, None), + (lhandler, None, True, True), + (tzhandler, None, True, True), + ('Questions about comments', None, None, None), + (chandler, None, True, True), + ] + + print("Creating Nikola Site") + print("====================\n") + print("This is Nikola v{0}. We will now ask you a few easy questions about your new site.".format(nikola.__version__)) + print("If you do not want to answer and want to go with the defaults instead, simply restart with the `-q` parameter.") + + for query, default, toconf, destination in questions: + if target and destination == '!target': + # Skip the destination question if we know it already + pass + else: + if default is toconf is destination is None: + print('--- {0} ---'.format(query)) + elif destination is True: + query(default, toconf) + else: + answer = ask(query, default) + if toconf: + SAMPLE_CONF[destination] = answer + if destination == '!target': + while not answer: + print(' ERROR: you need to specify a target directory.\n') + answer = ask(query, default) + STORAGE['target'] = answer + + print("\nThat's it, Nikola is now configured. Make sure to edit conf.py to your liking.") + print("If you are looking for themes and addons, check out http://themes.getnikola.com/ and http://plugins.getnikola.com/.") + print("Have fun!") + return STORAGE def _execute(self, options={}, args=None): """Create a new site.""" - if not args: - print("Usage: nikola init folder [options]") + try: + target = args[0] + except IndexError: + target = None + if not options.get('quiet'): + st = self.ask_questions(target=target) + try: + if not target: + target = st['target'] + except KeyError: + pass + + if not target: + print("Usage: nikola init [--demo] [--quiet] folder") + print(""" +Options: + -q, --quiet Do not ask questions about config. + -d, --demo Create a site filled with example data.""") return False - target = args[0] - if not options or not options.get('demo'): + if not options.get('demo'): self.create_empty_site(target) LOGGER.info('Created empty site at {0}.'.format(target)) else: |