novelWriter 2.2rc1__py3-none-any.whl → 2.3b1__py3-none-any.whl

novelwriter/core/buildsettings.py

@@ -7,7 +7,7 @@ Created: 2023-02-14 [2.1b1] BuildSettings
 Created: 2023-05-22 [2.1b1] BuildCollection
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -29,8 +29,8 @@ import uuid
 import logging
 
 from enum import Enum
-from typing import Iterable
 from pathlib import Path
+from collections.abc import Iterable
 
 from PyQt5.QtCore import QT_TRANSLATE_NOOP, QCoreApplication
 
@@ -79,6 +79,8 @@ SETTINGS_TEMPLATE = {
     "format.leftMargin":      (float, 2.0),
     "format.rightMargin":     (float, 2.0),
     "odt.addColours":         (bool, True),
+    "odt.pageHeader":         (str, nwHeadFmt.ODT_AUTO),
+    "odt.pageCountOffset":    (int, 0),
     "html.addStyles":         (bool, True),
 }
 
@@ -125,6 +127,8 @@ SETTINGS_LABELS = {
 
     "odt":                    QT_TRANSLATE_NOOP("Builds", "Open Document (.odt)"),
     "odt.addColours":         QT_TRANSLATE_NOOP("Builds", "Add Highlight Colours"),
+    "odt.pageHeader":         QT_TRANSLATE_NOOP("Builds", "Page Header"),
+    "odt.pageCountOffset":    QT_TRANSLATE_NOOP("Builds", "Page Counter Offset"),
 
     "html":                   QT_TRANSLATE_NOOP("Builds", "HTML (.html)"),
     "html.addStyles":         QT_TRANSLATE_NOOP("Builds", "Add CSS Styles"),
@@ -235,16 +239,12 @@ class BuildSettings:
     def getInt(self, key: str) -> int:
         """Type safe value access for integers."""
         value = self._settings.get(key, SETTINGS_TEMPLATE.get(key, (None, None))[1])
-        if isinstance(value, (int, float)):
-            return int(value)
-        return 0
+        return int(value) if isinstance(value, (int, float)) else 0
 
     def getFloat(self, key: str) -> float:
         """Type safe value access for floats."""
         value = self._settings.get(key, SETTINGS_TEMPLATE.get(key, (None, None))[1])
-        if isinstance(value, (int, float)):
-            return float(value)
-        return 0.0
+        return float(value) if isinstance(value, (int, float)) else 0.0
 
     ##
     #  Setters

novelwriter/core/coretools.py

@@ -6,9 +6,10 @@ File History:
 Created: 2022-10-02 [2.0rc1] DocMerger
 Created: 2022-10-11 [2.0rc1] DocSplitter
 Created: 2022-11-03 [2.0rc2] ProjectBuilder
+Created: 2023-07-20 [2.1b1]  DocDuplicator
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -28,16 +29,19 @@ from __future__ import annotations
 import shutil
 import logging
 
-from typing import Iterable
+from pathlib import Path
 from functools import partial
+from zipfile import ZipFile, is_zipfile
+from collections.abc import Iterable
 
 from PyQt5.QtCore import QCoreApplication
 
 from novelwriter import CONFIG, SHARED
-from novelwriter.common import minmax, simplified
-from novelwriter.constants import nwItemClass
+from novelwriter.common import isHandle, minmax, simplified
+from novelwriter.constants import nwFiles, nwItemClass
 from novelwriter.core.item import NWItem
 from novelwriter.core.project import NWProject
+from novelwriter.core.storage import NWStorageCreate
 
 logger = logging.getLogger(__name__)
 
@@ -276,28 +280,25 @@ class DocDuplicator:
         """Run through a list of items, duplicate them, and copy the
         text content if they are documents.
         """
-        if not items:
-            return
-
-        nHandle = items[0]
-        hMap: dict[str, str | None] = {t: None for t in items}
-        for tHandle in items:
-            newItem = self._project.tree.duplicate(tHandle)
-            if newItem is None:
-                return
-            hMap[tHandle] = newItem.itemHandle
-            if newItem.itemParent in hMap:
-                newItem.setParent(hMap[newItem.itemParent])
-                self._project.tree.updateItemData(newItem.itemHandle)
-            if newItem.isFileType():
-                oldDoc = self._project.storage.getDocument(tHandle)
-                newDoc = self._project.storage.getDocument(newItem.itemHandle)
-                if newDoc.fileExists():
+        if items:
+            nHandle = items[0]
+            hMap: dict[str, str | None] = {t: None for t in items}
+            for tHandle in items:
+                newItem = self._project.tree.duplicate(tHandle)
+                if newItem is None:
                     return
-                newDoc.writeDocument(oldDoc.readDocument() or "")
-            yield newItem.itemHandle, nHandle
-            nHandle = None
-
+                hMap[tHandle] = newItem.itemHandle
+                if newItem.itemParent in hMap:
+                    newItem.setParent(hMap[newItem.itemParent])
+                    self._project.tree.updateItemData(newItem.itemHandle)
+                if newItem.isFileType():
+                    oldDoc = self._project.storage.getDocument(tHandle)
+                    newDoc = self._project.storage.getDocument(newItem.itemHandle)
+                    if newDoc.fileExists():
+                        return
+                    newDoc.writeDocument(oldDoc.readDocument() or "")
+                yield newItem.itemHandle, nHandle
+                nHandle = None
         return
 
 # END Class DocDuplicator
@@ -309,55 +310,67 @@ class ProjectBuilder:
     """
 
     def __init__(self) -> None:
-        self.tr = partial(QCoreApplication.translate, "NWProject")
+        self._path = None
+        self.tr = partial(QCoreApplication.translate, "ProjectBuilder")
         return
 
+    @property
+    def projPath(self) -> Path | None:
+        """The path of the newly created project."""
+        return self._path
+
     ##
     #  Methods
     ##
 
     def buildProject(self, data: dict) -> bool:
-        """Build a project from a data dictionary of specifications
-        provided by the wizard.
-        """
-        if not isinstance(data, dict):
-            logger.error("Invalid call to newProject function")
-            return False
-
-        popMinimal = data.get("popMinimal", True)
-        popCustom = data.get("popCustom", False)
-        popSample = data.get("popSample", False)
+        """Build or copy a project from a data dictionary."""
+        if isinstance(data, dict):
+            path = data.get("path", None) or None
+            if isinstance(path, (str, Path)):
+                self._path = Path(path).resolve()
+                if data.get("sample", False):
+                    return self._extractSampleProject(self._path)
+                elif data.get("template"):
+                    return self._copyProject(self._path, data)
+                else:
+                    return self._buildAndPopulate(self._path, data)
+            SHARED.error("A project path is required.")
+        return False
 
-        # Check if we're extracting the sample project. This is handled
-        # differently as it isn't actually a new project, so we forward
-        # this to another function and return here.
-        if popSample:
-            return self._extractSampleProject(data)
-
-        projPath = data.get("projPath", None)
-        if projPath is None:
-            logger.error("No project path set for the new project")
-            return False
+    ##
+    #  Internal Functions
+    ##
 
+    def _buildAndPopulate(self, path: Path, data: dict) -> bool:
+        """Build a blank project from a data dictionary."""
         project = NWProject()
-        if not project.storage.openProjectInPlace(projPath, newProject=True):
+        status = project.storage.createNewProject(path)
+        if status == NWStorageCreate.NOT_EMPTY:
+            SHARED.error(self.tr(
+                "The target folder is not empty. "
+                "Please choose another folder."
+            ))
+            return False
+        elif status == NWStorageCreate.OS_ERROR:
+            SHARED.error(self.tr(
+                "An error occurred while trying to create the project."
+            ), exc=project.storage.exc)
             return False
 
+        self._path = project.storage.storagePath
+
         lblNewProject = self.tr("New Project")
-        lblNewChapter = self.tr("New Chapter")
-        lblNewScene   = self.tr("New Scene")
         lblTitlePage  = self.tr("Title Page")
         lblByAuthors  = self.tr("By")
 
         # Settings
-        projName = data.get("projName", lblNewProject)
-        projTitle = data.get("projTitle", lblNewProject)
-        projAuthor = data.get("projAuthor", "")
-        projLang = data.get("projLang", "en_GB")
+        projName = data.get("name", lblNewProject)
+        projAuthor = data.get("author", "")
+        projLang = data.get("language", "en_GB")
 
         project.data.setUuid(None)
         project.data.setName(projName)
-        project.data.setTitle(projTitle)
         project.data.setAuthor(projAuthor)
         project.data.setLanguage(projLang)
         project.setDefaultStatusImport()
@@ -366,7 +379,7 @@ class ProjectBuilder:
         # Add Root Folders
         hNovelRoot = project.newRoot(nwItemClass.NOVEL)
         hTitlePage = project.newFile(lblTitlePage, hNovelRoot)
-        novelTitle = project.data.title if project.data.title else project.data.name
+        novelTitle = project.data.name
 
         titlePage = f"#! {novelTitle}\n\n"
         if project.data.author:
@@ -375,116 +388,142 @@ class ProjectBuilder:
         aDoc = project.storage.getDocument(hTitlePage)
         aDoc.writeDocument(titlePage)
 
-        if popMinimal:
-            # Creating a minimal project with a few root folders and a
-            # single chapter with a single scene.
-            hChapter = project.newFile(lblNewChapter, hNovelRoot)
-            aDoc = project.storage.getDocument(hChapter)
-            aDoc.writeDocument(f"## {lblNewChapter}\n\n")
-
-            if hChapter:
-                hScene = project.newFile(lblNewScene, hChapter)
-                aDoc = project.storage.getDocument(hScene)
-                aDoc.writeDocument(f"### {lblNewScene}\n\n")
-
-            project.newRoot(nwItemClass.PLOT)
-            project.newRoot(nwItemClass.CHARACTER)
-            project.newRoot(nwItemClass.WORLD)
-            project.newRoot(nwItemClass.ARCHIVE)
-
-            project.saveProject()
-            project.closeProject()
-
-        elif popCustom:
-            # Create a project structure based on selected root folders
-            # and a number of chapters and scenes selected in the
-            # wizard's custom page.
-
-            # Create chapters and scenes
-            numChapters = data.get("numChapters", 0)
-            numScenes = data.get("numScenes", 0)
-
-            chSynop = self.tr("Summary of the chapter.")
-            scSynop = self.tr("Summary of the scene.")
-            bfNote = self.tr("A short description.")
-
-            # Create chapters
-            if numChapters > 0:
-                for ch in range(numChapters):
-                    chTitle = self.tr("Chapter {0}").format(f"{ch+1:d}")
-                    cHandle = project.newFile(chTitle, hNovelRoot)
-                    aDoc = project.storage.getDocument(cHandle)
-                    aDoc.writeDocument(f"## {chTitle}\n\n% Synopsis: {chSynop}\n\n")
-
-                    # Create chapter scenes
-                    if numScenes > 0 and cHandle:
-                        for sc in range(numScenes):
-                            scTitle = self.tr("Scene {0}").format(f"{ch+1:d}.{sc+1:d}")
-                            sHandle = project.newFile(scTitle, cHandle)
-                            aDoc = project.storage.getDocument(sHandle)
-                            aDoc.writeDocument(f"### {scTitle}\n\n% Synopsis: {scSynop}\n\n")
-
-            # Create scenes (no chapters)
-            elif numScenes > 0:
-                for sc in range(numScenes):
-                    scTitle = self.tr("Scene {0}").format(f"{sc+1:d}")
-                    sHandle = project.newFile(scTitle, hNovelRoot)
-                    aDoc = project.storage.getDocument(sHandle)
-                    aDoc.writeDocument(f"### {scTitle}\n\n% Synopsis: {scSynop}\n\n")
-
-            # Create notes folders
-            noteTitles = {
-                nwItemClass.PLOT: self.tr("Main Plot"),
-                nwItemClass.CHARACTER: self.tr("Protagonist"),
-                nwItemClass.WORLD: self.tr("Main Location"),
-            }
-
-            addNotes = data.get("addNotes", False)
-            for newRoot in data.get("addRoots", []):
-                if newRoot in nwItemClass:
-                    rHandle = project.newRoot(newRoot)
-                    if addNotes:
-                        aHandle = project.newFile(noteTitles[newRoot], rHandle)
-                        ntTag = simplified(noteTitles[newRoot]).replace(" ", "")
-                        aDoc = project.storage.getDocument(aHandle)
-                        aDoc.writeDocument(
-                            f"# {noteTitles[newRoot]}\n\n"
-                            f"@tag: {ntTag}\n\n"
-                            f"% Short: {bfNote}\n\n"
-                        )
-
-            # Also add the archive and trash folders
-            project.newRoot(nwItemClass.ARCHIVE)
-            project.trashFolder()
-
-            project.saveProject()
-            project.closeProject()
+        # Create a project structure based on selected root folders
+        # and a number of chapters and scenes selected in the
+        # wizard's custom page.
+
+        # Create chapters and scenes
+        numChapters = data.get("chapters", 0)
+        numScenes = data.get("scenes", 0)
+
+        chSynop = self.tr("Summary of the chapter.")
+        scSynop = self.tr("Summary of the scene.")
+        bfNote = self.tr("A short description.")
+
+        # Create chapters
+        if numChapters > 0:
+            for ch in range(numChapters):
+                chTitle = self.tr("Chapter {0}").format(f"{ch+1:d}")
+                cHandle = project.newFile(chTitle, hNovelRoot)
+                aDoc = project.storage.getDocument(cHandle)
+                aDoc.writeDocument(f"## {chTitle}\n\n%Synopsis: {chSynop}\n\n")
+
+                # Create chapter scenes
+                if numScenes > 0 and cHandle:
+                    for sc in range(numScenes):
+                        scTitle = self.tr("Scene {0}").format(f"{ch+1:d}.{sc+1:d}")
+                        sHandle = project.newFile(scTitle, cHandle)
+                        aDoc = project.storage.getDocument(sHandle)
+                        aDoc.writeDocument(f"### {scTitle}\n\n%Synopsis: {scSynop}\n\n")
+
+        # Create scenes (no chapters)
+        elif numScenes > 0:
+            for sc in range(numScenes):
+                scTitle = self.tr("Scene {0}").format(f"{sc+1:d}")
+                sHandle = project.newFile(scTitle, hNovelRoot)
+                aDoc = project.storage.getDocument(sHandle)
+                aDoc.writeDocument(f"### {scTitle}\n\n%Synopsis: {scSynop}\n\n")
+
+        # Create notes folders
+        noteTitles = {
+            nwItemClass.PLOT: self.tr("Main Plot"),
+            nwItemClass.CHARACTER: self.tr("Protagonist"),
+            nwItemClass.WORLD: self.tr("Main Location"),
+        }
+
+        addNotes = data.get("notes", False)
+        for newRoot in data.get("roots", []):
+            if newRoot in nwItemClass:
+                rHandle = project.newRoot(newRoot)
+                if addNotes:
+                    aHandle = project.newFile(noteTitles[newRoot], rHandle)
+                    ntTag = simplified(noteTitles[newRoot]).replace(" ", "")
+                    aDoc = project.storage.getDocument(aHandle)
+                    aDoc.writeDocument(
+                        f"# {noteTitles[newRoot]}\n\n"
+                        f"@tag: {ntTag}\n\n"
+                        f"%Short: {bfNote}\n\n"
+                    )
+
+        # Also add the archive and trash folders
+        project.newRoot(nwItemClass.ARCHIVE)
+        project.trashFolder()
+
+        project.saveProject()
+        project.closeProject()
 
         return True
 
-    ##
-    #  Internal Functions
-    ##
+    def _copyProject(self, path: Path, data: dict) -> bool:
+        """Copy an existing project content, but not the meta data, and
+        update new settings.
+        """
+        source = data.get("template")
+        if not (isinstance(source, Path) and source.is_file()
+                and (source.name == nwFiles.PROJ_FILE or is_zipfile(source))):
+            logger.error("Could not access source project: %s", source)
+            return False
 
-    def _extractSampleProject(self, data: dict) -> bool:
+        logger.info("Copying project: %s", source)
+        if path.exists():
+            SHARED.error(self.tr(
+                "The target folder already exists. "
+                "Please choose another folder."
+            ))
+            return False
+
+        # Begin copying
+        srcPath = source.parent
+        dstPath = path.resolve()
+        srcCont = srcPath / "content"
+        dstCont = dstPath / "content"
+        try:
+            dstPath.mkdir(exist_ok=True)
+            dstCont.mkdir(exist_ok=True)
+            if is_zipfile(source):
+                with ZipFile(source) as zipObj:
+                    for member in zipObj.namelist():
+                        if member == nwFiles.PROJ_FILE:
+                            zipObj.extract(member, dstPath)
+                        elif member.startswith("content") and member.endswith(".nwd"):
+                            zipObj.extract(member, dstPath)
+            else:
+                shutil.copy2(srcPath / nwFiles.PROJ_FILE, dstPath)
+                for item in srcCont.iterdir():
+                    if item.is_file() and item.suffix == ".nwd" and isHandle(item.stem):
+                        shutil.copy2(item, dstCont)
+        except Exception as exc:
+            SHARED.error(self.tr("Could not copy project files."), exc=exc)
+            return False
+
+        # Open the copied project and update settings
+        project = NWProject()
+        project.openProject(dstPath)
+        project.data.setUuid("")  # Creates a fresh uuid
+        project.data.setName(data.get("name", "None"))
+        project.data.setAuthor(data.get("author", ""))
+        project.data.setLanguage(data.get("language", "en_GB"))
+        project.data.setSpellCheck(True)
+        project.data.setSpellLang(None)
+        project.data.setDoBackup(True)
+        project.data.setSaveCount(0)
+        project.data.setAutoCount(0)
+        project.data.setEditTime(0)
+        project.saveProject()
+        project.closeProject()
+
+        return True
+
+    def _extractSampleProject(self, path: Path) -> bool:
         """Make a copy of the sample project by extracting the
         sample.zip file to the new path.
         """
-        projPath = data.get("projPath", None)
-        if projPath is None:
-            logger.error("No project path set for the example project")
-            return False
-
-        pkgSample = CONFIG.assetPath("sample.zip")
-        if pkgSample.is_file():
+        if (sample := CONFIG.assetPath("sample.zip")).is_file():
             try:
-                shutil.unpack_archive(pkgSample, projPath)
+                shutil.unpack_archive(sample, path)
             except Exception as exc:
-                SHARED.error(self.tr(
-                    "Failed to create a new example project."
-                ), exc=exc)
+                SHARED.error(self.tr("Failed to create a new example project."), exc=exc)
                 return False
-
         else:
             SHARED.error(self.tr(
                 "Failed to create a new example project. "

novelwriter/core/docbuild.py

@@ -6,7 +6,7 @@ File History:
 Created: 2022-12-01 [2.1b1] NWBuildDocument
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -25,8 +25,8 @@ from __future__ import annotations
 
 import logging
 
-from typing import Iterable
 from pathlib import Path
+from collections.abc import Iterable
 
 from PyQt5.QtGui import QFont, QFontInfo
 
@@ -248,8 +248,8 @@ class NWBuildDocument:
     def _setupBuild(self, bldObj: Tokenizer) -> dict:
         """Configure the build object."""
         # Get Settings
-        textFont  = self._build.getStr("format.textFont")
-        textSize  = self._build.getInt("format.textSize")
+        textFont = self._build.getStr("format.textFont")
+        textSize = self._build.getInt("format.textSize")
 
         fontFamily = textFont or CONFIG.textFont
         bldFont = QFont(fontFamily, textSize)
@@ -284,6 +284,9 @@ class NWBuildDocument:
         if isinstance(bldObj, ToOdt):
             bldObj.setColourHeaders(self._build.getBool("odt.addColours"))
             bldObj.setLanguage(self._project.data.language)
+            bldObj.setHeaderFormat(
+                self._build.getStr("odt.pageHeader"), self._build.getInt("odt.pageCountOffset")
+            )
 
             scale = nwLabels.UNIT_SCALE.get(self._build.getStr("format.pageUnit"), 1.0)
             pW, pH = nwLabels.PAPER_SIZE.get(self._build.getStr("format.pageSize"), (-1.0, -1.0))

novelwriter/core/document.py

@@ -6,7 +6,7 @@ File History:
 Created: 2018-09-29 [0.0.1]
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -52,7 +52,7 @@ class NWDocument:
 
     def __init__(self, project: NWProject, tHandle: str | None) -> None:
 
-        self._project  = project
+        self._project = project
 
         self._item      = None   # The currently open item
         self._handle    = None   # The handle of the currently open item
@@ -284,12 +284,12 @@ class NWDocument:
         """Parse the document meta tag and return the name, parent,
         class and layout meta values.
         """
-        theName = self._docMeta.get("name", "")
-        theParent = self._docMeta.get("parent", None)
-        theClass = self._docMeta.get("class", None)
-        theLayout = self._docMeta.get("layout", None)
+        name = self._docMeta.get("name", "")
+        parent = self._docMeta.get("parent", None)
+        itemClass = self._docMeta.get("class", None)
+        itemLayout = self._docMeta.get("layout", None)
 
-        return theName, theParent, theClass, theLayout
+        return name, parent, itemClass, itemLayout
 
     def getError(self) -> str:
         """Return the last recorded exception."""