silverstripe / silverstripe-documentconverter

tests/PageExtensionTest.php

Indentation +12 added lines, -12 removed lines

@@ -9,17 +9,17 @@
 
 class PageExtensionTest extends SapphireTest
 {
-    protected static $required_extensions = [
-        SiteTree::class => [PageExtension::class]
-    ];
+	protected static $required_extensions = [
+		SiteTree::class => [PageExtension::class]
+	];
 
-    public function testFieldListHasDocumentImportField()
-    {
-        $siteTree = new SiteTree;
-        $fields = $siteTree->getCMSFields();
-        $this->assertInstanceOf(
-            SettingsField::class,
-            $fields->fieldByName('Root.Import')->Fields()->First()
-        );
-    }
+	public function testFieldListHasDocumentImportField()
+	{
+		$siteTree = new SiteTree;
+		$fields = $siteTree->getCMSFields();
+		$this->assertInstanceOf(
+			SettingsField::class,
+			$fields->fieldByName('Root.Import')->Fields()->First()
+		);
+	}
 }

src/ImportField.php

Spacing +26 added lines, -27 removed lines

@@ -94,11 +94,11 @@ 
 
         if (!$return['error']) {
             // Get options for this import.
-            $splitHeader = (int)$request->postVar('SplitHeader');
-            $keepSource = (bool)$request->postVar('KeepSource');
-            $chosenFolderID = (int)$request->postVar('ChosenFolderID');
-            $publishPages = (bool)$request->postVar('PublishPages');
-            $includeTOC = (bool)$request->postVar('IncludeTOC');
+            $splitHeader = (int) $request->postVar('SplitHeader');
+            $keepSource = (bool) $request->postVar('KeepSource');
+            $chosenFolderID = (int) $request->postVar('ChosenFolderID');
+            $publishPages = (bool) $request->postVar('PublishPages');
+            $includeTOC = (bool) $request->postVar('IncludeTOC');
 
             // Process the document and write the page.
             $preservedDocument = null;
@@ -154,9 +154,9 @@ 
         if ($page) {
             if ($page->Children()->Count() > 0) {
                 foreach ($page->Children() as $child) {
-                    $content .= '<li><a href="' . $child->Link() . '">' . $child->Title . '</a></li>';
+                    $content .= '<li><a href="'.$child->Link().'">'.$child->Title.'</a></li>';
                 }
-                $page->Content = $content . '</ul>';
+                $page->Content = $content.'</ul>';
             } else {
                 $doc = new DOMDocument();
                 $doc->loadHTML($page->Content);
@@ -165,30 +165,30 @@ 
                 $h1 = $h2 = 1;
                 while ($node) {
                     if ($node instanceof DOMElement && $node->tagName == 'h1') {
-                        $content .= '<li><a href="#h1.' . $h1 . '">' .
-                            trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) .
+                        $content .= '<li><a href="#h1.'.$h1.'">'.
+                            trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))).
                             '</a></li>';
                         $node->setAttributeNode(new DOMAttr("id", "h1.".$h1));
                         $h1++;
                     } elseif ($node instanceof DOMElement && $node->tagName == 'h2') {
-                        $content .= '<li class="menu-h2"><a href="#h2.' . $h2 . '">' .
-                            trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) .
+                        $content .= '<li class="menu-h2"><a href="#h2.'.$h2.'">'.
+                            trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))).
                             '</a></li>';
                         $node->setAttributeNode(new DOMAttr("id", "h2.".$h2));
                         $h2++;
                     }
                     $node = $node->nextSibling;
                 }
-                $page->Content = $content . '</ul>' . $doc->saveHTML();
+                $page->Content = $content.'</ul>'.$doc->saveHTML();
             }
 
             // Add in the link to the original document, if provided.
             if ($preservedDocument) {
-                $page->Content = '<a href="' .
-                    $preservedDocument->Link() .
-                    '" title="download original document">download original document (' .
-                    $preservedDocument->getSize() .
-                    ')</a>' .
+                $page->Content = '<a href="'.
+                    $preservedDocument->Link().
+                    '" title="download original document">download original document ('.
+                    $preservedDocument->getSize().
+                    ')</a>'.
                     $page->Content;
             }
 
@@ -245,7 +245,7 @@ 
             }
 
             unset($this->unusedChildren[$page->ID]);
-            file_put_contents(ASSETS_PATH . '/index-' . $sort . '.html', $this->getBodyText($subdoc, $subnode));
+            file_put_contents(ASSETS_PATH.'/index-'.$sort.'.html', $this->getBodyText($subdoc, $subnode));
 
             if ($sort) {
                 $page->Sort = $sort;
@@ -315,20 +315,20 @@ 
 
         // make sure any images are added as Image records with a relative link to assets
         $chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
-        $folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
+        $folderName = ($chosenFolder) ? '/'.$chosenFolder->Name : '';
         $imgs = $xpath->query('//img');
         for ($i = 0; $i < $imgs->length; $i++) {
             $img = $imgs->item($i);
-            $originalPath = 'assets/' . $folderName . '/' . $img->getAttribute('src');
+            $originalPath = 'assets/'.$folderName.'/'.$img->getAttribute('src');
             $name = FileNameFilter::create()->filter(basename($originalPath));
 
             $image = Image::get()->filter([
                 'Name' => $name,
-                'ParentID' => (int)$chosenFolderID
+                'ParentID' => (int) $chosenFolderID
             ])->first();
             if (!($image && $image->exists())) {
                 $image = Image::create();
-                $image->ParentID = (int)$chosenFolderID;
+                $image->ParentID = (int) $chosenFolderID;
                 $image->Name = $name;
                 $image->write();
             }
@@ -364,8 +364,7 @@ 
                 if ($parenttag) {
                     $parent = $doc->createElement($parenttag);
                     $node->nextSibling ?
-                        $node->parentNode->insertBefore($parent, $node->nextSibling) :
-                        $node->parentNode->appendChild($parent);
+                        $node->parentNode->insertBefore($parent, $node->nextSibling) : $node->parentNode->appendChild($parent);
                 }
 
                 while ($node->firstChild) {
@@ -399,7 +398,7 @@ 
             // Empty paragraphs
             '//p[not(descendant-or-self::text() | descendant-or-self::img)]',
             // Empty headers
-            '//*[' . implode(' | ', $headingXPath) . '][not(descendant-or-self::text() | descendant-or-self::img)]',
+            '//*['.implode(' | ', $headingXPath).'][not(descendant-or-self::text() | descendant-or-self::img)]',
             // Anchors
             '//a[not(@href)]',
             // BR tags
@@ -432,7 +431,7 @@ 
 
         $documentImporterFieldError = false;
 
-        $documentImporterFieldErrorHandler = function (
+        $documentImporterFieldErrorHandler = function(
             $errno,
             $errstr,
             $errfile,
@@ -457,7 +456,7 @@ 
         $sort = 1;
         if ($splitHeader == 1 || $splitHeader == 2) {
             while ($node && !$documentImporterFieldError) {
-                if ($node instanceof DOMElement && $node->tagName == 'h' . $splitHeader) {
+                if ($node instanceof DOMElement && $node->tagName == 'h'.$splitHeader) {
                     if ($subnode->hasChildNodes()) {
                         $this->writeContent($subtitle, $subdoc, $subnode, $sort, $publishPages);
                         $sort++;

Indentation +447 added lines, -447 removed lines

@@ -54,451 +54,451 @@
 class ImportField extends UploadField
 {
 
-    private static $allowed_actions = ['upload'];
-
-    private static $importer_class = ServiceConnector::class;
-
-    /**
-     * Process the document immediately upon upload.
-     */
-    public function upload(HTTPRequest $request)
-    {
-        if ($this->isDisabled() || $this->isReadonly()) {
-            return $this->httpError(403);
-        }
-
-        // Protect against CSRF on destructive action
-        $token = $this->getForm()->getSecurityToken();
-        if (!$token->checkRequest($request)) {
-            return $this->httpError(400);
-        }
-
-        $tmpfile = $request->postVar('Upload');
-
-        // Check if the file has been uploaded into the temporary storage.
-        if (!$tmpfile) {
-            $return = [
-                'error' => _t(
-                    'SilverStripe\\AssetAdmin\\Forms\\UploadField.FIELDNOTSET',
-                    'File information not found'
-                )
-            ];
-        } else {
-            $return = [
-                'name' => $tmpfile['name'],
-                'size' => $tmpfile['size'],
-                'type' => $tmpfile['type'],
-                'error' => $tmpfile['error']
-            ];
-        }
-
-        if (!$return['error']) {
-            // Get options for this import.
-            $splitHeader = (int)$request->postVar('SplitHeader');
-            $keepSource = (bool)$request->postVar('KeepSource');
-            $chosenFolderID = (int)$request->postVar('ChosenFolderID');
-            $publishPages = (bool)$request->postVar('PublishPages');
-            $includeTOC = (bool)$request->postVar('IncludeTOC');
-
-            // Process the document and write the page.
-            $preservedDocument = null;
-            if ($keepSource) {
-                $preservedDocument = $this->preserveSourceDocument($tmpfile, $chosenFolderID);
-            }
-
-            $importResult = $this->importFromPOST($tmpfile, $splitHeader, $publishPages, $chosenFolderID);
-            if (is_array($importResult) && isset($importResult['error'])) {
-                $return['error'] = $importResult['error'];
-            } elseif ($includeTOC) {
-                $this->writeTOC($publishPages, $keepSource ? $preservedDocument : null);
-            }
-        }
-
-        $response = HTTPResponse::create(Convert::raw2json([$return]));
-        $response->addHeader('Content-Type', 'application/json');
-        return $response;
-    }
-
-    /**
-     * Preserves the source file by copying it to a specified folder.
-     *
-     * @param $tmpfile Temporary file data structure.
-     * @param int $chosenFolderID Target folder.
-     * @return File Stored file.
-     */
-    protected function preserveSourceDocument($tmpfile, $chosenFolderID = null)
-    {
-        $upload = Upload::create();
-
-        $file = File::create();
-        $upload->loadIntoFile($tmpfile, $file, $chosenFolderID);
-
-        $page = $this->form->getRecord();
-        $page->ImportedFromFileID = $file->ID;
-        $page->write();
-
-        return $file;
-    }
-
-    /**
-     * Builds and writes the table of contents for the document.
-     *
-     * @param bool $publishPage Should the parent page be published.
-     * @param File $preservedDocument Set if the link to the original document should be added.
-     */
-    protected function writeTOC($publishPages = false, $preservedDocument = null)
-    {
-        $page = $this->form->getRecord();
-        $content = '<ul>';
-
-        if ($page) {
-            if ($page->Children()->Count() > 0) {
-                foreach ($page->Children() as $child) {
-                    $content .= '<li><a href="' . $child->Link() . '">' . $child->Title . '</a></li>';
-                }
-                $page->Content = $content . '</ul>';
-            } else {
-                $doc = new DOMDocument();
-                $doc->loadHTML($page->Content);
-                $body = $doc->getElementsByTagName('body')->item(0);
-                $node = $body->firstChild;
-                $h1 = $h2 = 1;
-                while ($node) {
-                    if ($node instanceof DOMElement && $node->tagName == 'h1') {
-                        $content .= '<li><a href="#h1.' . $h1 . '">' .
-                            trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) .
-                            '</a></li>';
-                        $node->setAttributeNode(new DOMAttr("id", "h1.".$h1));
-                        $h1++;
-                    } elseif ($node instanceof DOMElement && $node->tagName == 'h2') {
-                        $content .= '<li class="menu-h2"><a href="#h2.' . $h2 . '">' .
-                            trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) .
-                            '</a></li>';
-                        $node->setAttributeNode(new DOMAttr("id", "h2.".$h2));
-                        $h2++;
-                    }
-                    $node = $node->nextSibling;
-                }
-                $page->Content = $content . '</ul>' . $doc->saveHTML();
-            }
-
-            // Add in the link to the original document, if provided.
-            if ($preservedDocument) {
-                $page->Content = '<a href="' .
-                    $preservedDocument->Link() .
-                    '" title="download original document">download original document (' .
-                    $preservedDocument->getSize() .
-                    ')</a>' .
-                    $page->Content;
-            }
-
-            // Store the result
-            $page->write();
-            if ($publishPages) {
-                $page->publishRecursive();
-            }
-        }
-    }
-
-    protected function getBodyText($doc, $node)
-    {
-        // Build a new doc
-        $htmldoc = new DOMDocument();
-        // Create the html element
-        $html = $htmldoc->createElement('html');
-        $htmldoc->appendChild($html);
-        // Append the body node
-        $html->appendChild($htmldoc->importNode($node, true));
-
-        // Get the text as html, remove the entry and exit root tags and return
-        $text = $htmldoc->saveHTML();
-        $text = preg_replace('/^.*<body>/', '', $text);
-        $text = preg_replace('/<\/body>.*$/', '', $text);
-
-        return $text;
-    }
-
-    /**
-     * Used only when writing the document that has been split by headers.
-     * Can write both to the chapter pages as well as the master page.
-     *
-     * @param string $subtitle Title of the chapter - if missing, it will write to the master page.
-     * @param $subdoc
-     * @param $subnode
-     * @param int $sort Order of the chapter page.
-     * @param $publishPages Whether to publish the resulting child/master pages.
-     */
-    protected function writeContent($subtitle, $subdoc, $subnode, $sort = null, $publishPages = false)
-    {
-        $record = $this->form->getRecord();
-
-        if ($subtitle) {
-            // Write the chapter page to a subpage.
-            $page = DataObject::get_one(
-                'Page',
-                sprintf('"Title" = \'%s\' AND "ParentID" = %d', $subtitle, $record->ID)
-            );
-            if (!$page) {
-                $page = Page::create();
-                $page->ParentID = $record->ID;
-                $page->Title = $subtitle;
-            }
-
-            unset($this->unusedChildren[$page->ID]);
-            file_put_contents(ASSETS_PATH . '/index-' . $sort . '.html', $this->getBodyText($subdoc, $subnode));
-
-            if ($sort) {
-                $page->Sort = $sort;
-            }
-            $page->Content = $this->getBodyText($subdoc, $subnode);
-            $page->write();
-            if ($publishPages) {
-                $page->publishRecursive();
-            }
-        } else {
-            // Write to the master page.
-            $record->Content = $this->getBodyText($subdoc, $subnode);
-            $record->write();
-
-            if ($publishPages) {
-                $record->publishRecursive();
-            }
-        }
-    }
-
-    /**
-     * Imports a document at a certain path onto the current page and writes it.
-     * CAUTION: Overwrites any existing content on the page!
-     *
-     * @param array $tmpFile Array as received from PHP's POST upload.
-     * @param bool $splitHeader Heading level to split by.
-     * @param bool $publishPages Whether the underlying pages should be published after import.
-     * @param int $chosenFolderID ID of the working folder - here the converted file and images will be stored.
-     */
-    public function importFromPOST($tmpFile, $splitHeader = false, $publishPages = false, $chosenFolderID = null)
-    {
-
-        $fileDescriptor = [
-            'name' => $tmpFile['name'],
-            'path' => $tmpFile['tmp_name'],
-            'mimeType' => $tmpFile['type']
-        ];
-
-        $sourcePage = $this->form->getRecord();
-        $importerClass = $this->config()->get('importer_class');
-        $importer = Injector::inst()->create($importerClass, $fileDescriptor, $chosenFolderID);
-        $content = $importer->import();
-
-        if (is_array($content) && isset($content['error'])) {
-            return $content;
-        }
-
-        // Clean up with tidy (requires tidy module)
-        $tidy = new Tidy();
-        $tidy->parseString($content, ['output-xhtml' => true], 'utf8');
-        $tidy->cleanRepair();
-
-        $fragment = [];
-        foreach ($tidy->body()->child as $child) {
-            $fragment[] = $child->value;
-        }
-
-        $htmlValue = Injector::inst()->create(HTMLValue::class, implode("\n", $fragment));
-
-        // Sanitise
-        $santiser = Injector::inst()->create(HTMLEditorSanitiser::class, HTMLEditorConfig::get_active());
-        $santiser->sanitise($htmlValue);
-
-        // Load in the HTML
-        $doc = $htmlValue->getDocument();
-        $xpath = new DOMXPath($doc);
-
-        // make sure any images are added as Image records with a relative link to assets
-        $chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
-        $folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
-        $imgs = $xpath->query('//img');
-        for ($i = 0; $i < $imgs->length; $i++) {
-            $img = $imgs->item($i);
-            $originalPath = 'assets/' . $folderName . '/' . $img->getAttribute('src');
-            $name = FileNameFilter::create()->filter(basename($originalPath));
-
-            $image = Image::get()->filter([
-                'Name' => $name,
-                'ParentID' => (int)$chosenFolderID
-            ])->first();
-            if (!($image && $image->exists())) {
-                $image = Image::create();
-                $image->ParentID = (int)$chosenFolderID;
-                $image->Name = $name;
-                $image->write();
-            }
-
-            // make sure it's put in place correctly so Image record knows where it is.
-            // e.g. in the case of underscores being renamed to dashes.
-            @rename(Director::getAbsFile($originalPath), Director::getAbsFile($image->getFilename()));
-
-            $img->setAttribute('src', $image->getFilename());
-        }
-
-        $remove_rules = [
-            // Change any headers that contain font tags (other than font face tags) into p elements
-            '//h1[.//font[not(@face)]]' => 'p',
-            // Remove any font tags
-            '//font'
-        ];
-
-        foreach ($remove_rules as $rule => $parenttag) {
-            if (is_numeric($rule)) {
-                $rule = $parenttag;
-                $parenttag = null;
-            }
-
-            $nodes = [];
-            foreach ($xpath->query($rule) as $node) {
-                $nodes[] = $node;
-            }
-
-            foreach ($nodes as $node) {
-                $parent = $node->parentNode;
-
-                if ($parenttag) {
-                    $parent = $doc->createElement($parenttag);
-                    $node->nextSibling ?
-                        $node->parentNode->insertBefore($parent, $node->nextSibling) :
-                        $node->parentNode->appendChild($parent);
-                }
-
-                while ($node->firstChild) {
-                    $parent->appendChild($node->firstChild);
-                }
-                $node->parentNode->removeChild($node);
-            }
-        }
-
-        // Strip style, class, lang attributes.
-        $els = $doc->getElementsByTagName('*');
-        for ($i = 0; $i < $els->length; $i++) {
-            $el = $els->item($i);
-            $el->removeAttribute('class');
-            $el->removeAttribute('style');
-            $el->removeAttribute('lang');
-        }
-
-        $els = $doc->getElementsByTagName('*');
-
-        $headingXPath = [
-            'self::h1',
-            'self::h2',
-            'self::h3',
-            'self::h4',
-            'self::h5',
-            'self::h6',
-        ];
-        // Remove a bunch of unwanted elements
-        $clean = [
-            // Empty paragraphs
-            '//p[not(descendant-or-self::text() | descendant-or-self::img)]',
-            // Empty headers
-            '//*[' . implode(' | ', $headingXPath) . '][not(descendant-or-self::text() | descendant-or-self::img)]',
-            // Anchors
-            '//a[not(@href)]',
-            // BR tags
-            '//br'
-        ];
-
-        foreach ($clean as $query) {
-            // First get all the nodes. Need to build array, as they'll disappear from the
-            // nodelist while we're deleteing them, causing the indexing to screw up.
-            $nodes = [];
-            foreach ($xpath->query($query) as $node) {
-                $nodes[] = $node;
-            }
-
-            // Then remove them all
-            foreach ($nodes as $node) {
-                if ($node->parentNode) {
-                    $node->parentNode->removeChild($node);
-                }
-            }
-        }
-
-        // Now split the document into portions by H1
-        $body = $doc->getElementsByTagName('body')->item(0);
-
-        $this->unusedChildren = [];
-        foreach ($sourcePage->Children() as $child) {
-            $this->unusedChildren[$child->ID] = $child;
-        }
-
-        $documentImporterFieldError = false;
-
-        $documentImporterFieldErrorHandler = function (
-            $errno,
-            $errstr,
-            $errfile,
-            $errline
-        ) use ($documentImporterFieldError) {
-            $documentImporterFieldError = _t(
-                'SilverStripe\\DocumentConverter\\ServiceConnector.PROCESSFAILED',
-                'Could not process document, please double-check you uploaded a .doc or .docx format.',
-                'Document Converter processes Word documents into HTML.'
-            );
-
-            // Do not cascade the error through other handlers
-            return true;
-        };
-
-        set_error_handler($documentImporterFieldErrorHandler);
-
-        $subtitle = null;
-        $subdoc = new DOMDocument();
-        $subnode = $subdoc->createElement('body');
-        $node = $body->firstChild;
-        $sort = 1;
-        if ($splitHeader == 1 || $splitHeader == 2) {
-            while ($node && !$documentImporterFieldError) {
-                if ($node instanceof DOMElement && $node->tagName == 'h' . $splitHeader) {
-                    if ($subnode->hasChildNodes()) {
-                        $this->writeContent($subtitle, $subdoc, $subnode, $sort, $publishPages);
-                        $sort++;
-                    }
-
-                    $subdoc = new DOMDocument();
-                    $subnode = $subdoc->createElement('body');
-                    $subtitle = trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent)));
-                } else {
-                    $subnode->appendChild($subdoc->importNode($node, true));
-                }
-
-                $node = $node->nextSibling;
-            }
-        } else {
-            $this->writeContent($subtitle, $subdoc, $body, null, $publishPages);
-        }
-
-        if ($subnode->hasChildNodes() && !$documentImporterFieldError) {
-            $this->writeContent($subtitle, $subdoc, $subnode, null, $publishPages);
-        }
-
-        restore_error_handler();
-        if ($documentImporterFieldError) {
-            return ['error' => $documentImporterFieldError];
-        }
-
-        foreach ($this->unusedChildren as $child) {
-            $origStage = Versioned::current_stage();
-
-            Versioned::set_stage(Versioned::DRAFT);
-            $draft = clone $child;
-            $draft->delete();
-
-            Versioned::set_stage(Versioned::LIVE);
-            $published = clone $child;
-            $published->delete();
-
-            Versioned::set_stage($origStage);
-        }
-
-        $sourcePage->write();
-    }
+	private static $allowed_actions = ['upload'];
+
+	private static $importer_class = ServiceConnector::class;
+
+	/**
+	 * Process the document immediately upon upload.
+	 */
+	public function upload(HTTPRequest $request)
+	{
+		if ($this->isDisabled() || $this->isReadonly()) {
+			return $this->httpError(403);
+		}
+
+		// Protect against CSRF on destructive action
+		$token = $this->getForm()->getSecurityToken();
+		if (!$token->checkRequest($request)) {
+			return $this->httpError(400);
+		}
+
+		$tmpfile = $request->postVar('Upload');
+
+		// Check if the file has been uploaded into the temporary storage.
+		if (!$tmpfile) {
+			$return = [
+				'error' => _t(
+					'SilverStripe\\AssetAdmin\\Forms\\UploadField.FIELDNOTSET',
+					'File information not found'
+				)
+			];
+		} else {
+			$return = [
+				'name' => $tmpfile['name'],
+				'size' => $tmpfile['size'],
+				'type' => $tmpfile['type'],
+				'error' => $tmpfile['error']
+			];
+		}
+
+		if (!$return['error']) {
+			// Get options for this import.
+			$splitHeader = (int)$request->postVar('SplitHeader');
+			$keepSource = (bool)$request->postVar('KeepSource');
+			$chosenFolderID = (int)$request->postVar('ChosenFolderID');
+			$publishPages = (bool)$request->postVar('PublishPages');
+			$includeTOC = (bool)$request->postVar('IncludeTOC');
+
+			// Process the document and write the page.
+			$preservedDocument = null;
+			if ($keepSource) {
+				$preservedDocument = $this->preserveSourceDocument($tmpfile, $chosenFolderID);
+			}
+
+			$importResult = $this->importFromPOST($tmpfile, $splitHeader, $publishPages, $chosenFolderID);
+			if (is_array($importResult) && isset($importResult['error'])) {
+				$return['error'] = $importResult['error'];
+			} elseif ($includeTOC) {
+				$this->writeTOC($publishPages, $keepSource ? $preservedDocument : null);
+			}
+		}
+
+		$response = HTTPResponse::create(Convert::raw2json([$return]));
+		$response->addHeader('Content-Type', 'application/json');
+		return $response;
+	}
+
+	/**
+	 * Preserves the source file by copying it to a specified folder.
+	 *
+	 * @param $tmpfile Temporary file data structure.
+	 * @param int $chosenFolderID Target folder.
+	 * @return File Stored file.
+	 */
+	protected function preserveSourceDocument($tmpfile, $chosenFolderID = null)
+	{
+		$upload = Upload::create();
+
+		$file = File::create();
+		$upload->loadIntoFile($tmpfile, $file, $chosenFolderID);
+
+		$page = $this->form->getRecord();
+		$page->ImportedFromFileID = $file->ID;
+		$page->write();
+
+		return $file;
+	}
+
+	/**
+	 * Builds and writes the table of contents for the document.
+	 *
+	 * @param bool $publishPage Should the parent page be published.
+	 * @param File $preservedDocument Set if the link to the original document should be added.
+	 */
+	protected function writeTOC($publishPages = false, $preservedDocument = null)
+	{
+		$page = $this->form->getRecord();
+		$content = '<ul>';
+
+		if ($page) {
+			if ($page->Children()->Count() > 0) {
+				foreach ($page->Children() as $child) {
+					$content .= '<li><a href="' . $child->Link() . '">' . $child->Title . '</a></li>';
+				}
+				$page->Content = $content . '</ul>';
+			} else {
+				$doc = new DOMDocument();
+				$doc->loadHTML($page->Content);
+				$body = $doc->getElementsByTagName('body')->item(0);
+				$node = $body->firstChild;
+				$h1 = $h2 = 1;
+				while ($node) {
+					if ($node instanceof DOMElement && $node->tagName == 'h1') {
+						$content .= '<li><a href="#h1.' . $h1 . '">' .
+							trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) .
+							'</a></li>';
+						$node->setAttributeNode(new DOMAttr("id", "h1.".$h1));
+						$h1++;
+					} elseif ($node instanceof DOMElement && $node->tagName == 'h2') {
+						$content .= '<li class="menu-h2"><a href="#h2.' . $h2 . '">' .
+							trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) .
+							'</a></li>';
+						$node->setAttributeNode(new DOMAttr("id", "h2.".$h2));
+						$h2++;
+					}
+					$node = $node->nextSibling;
+				}
+				$page->Content = $content . '</ul>' . $doc->saveHTML();
+			}
+
+			// Add in the link to the original document, if provided.
+			if ($preservedDocument) {
+				$page->Content = '<a href="' .
+					$preservedDocument->Link() .
+					'" title="download original document">download original document (' .
+					$preservedDocument->getSize() .
+					')</a>' .
+					$page->Content;
+			}
+
+			// Store the result
+			$page->write();
+			if ($publishPages) {
+				$page->publishRecursive();
+			}
+		}
+	}
+
+	protected function getBodyText($doc, $node)
+	{
+		// Build a new doc
+		$htmldoc = new DOMDocument();
+		// Create the html element
+		$html = $htmldoc->createElement('html');
+		$htmldoc->appendChild($html);
+		// Append the body node
+		$html->appendChild($htmldoc->importNode($node, true));
+
+		// Get the text as html, remove the entry and exit root tags and return
+		$text = $htmldoc->saveHTML();
+		$text = preg_replace('/^.*<body>/', '', $text);
+		$text = preg_replace('/<\/body>.*$/', '', $text);
+
+		return $text;
+	}
+
+	/**
+	 * Used only when writing the document that has been split by headers.
+	 * Can write both to the chapter pages as well as the master page.
+	 *
+	 * @param string $subtitle Title of the chapter - if missing, it will write to the master page.
+	 * @param $subdoc
+	 * @param $subnode
+	 * @param int $sort Order of the chapter page.
+	 * @param $publishPages Whether to publish the resulting child/master pages.
+	 */
+	protected function writeContent($subtitle, $subdoc, $subnode, $sort = null, $publishPages = false)
+	{
+		$record = $this->form->getRecord();
+
+		if ($subtitle) {
+			// Write the chapter page to a subpage.
+			$page = DataObject::get_one(
+				'Page',
+				sprintf('"Title" = \'%s\' AND "ParentID" = %d', $subtitle, $record->ID)
+			);
+			if (!$page) {
+				$page = Page::create();
+				$page->ParentID = $record->ID;
+				$page->Title = $subtitle;
+			}
+
+			unset($this->unusedChildren[$page->ID]);
+			file_put_contents(ASSETS_PATH . '/index-' . $sort . '.html', $this->getBodyText($subdoc, $subnode));
+
+			if ($sort) {
+				$page->Sort = $sort;
+			}
+			$page->Content = $this->getBodyText($subdoc, $subnode);
+			$page->write();
+			if ($publishPages) {
+				$page->publishRecursive();
+			}
+		} else {
+			// Write to the master page.
+			$record->Content = $this->getBodyText($subdoc, $subnode);
+			$record->write();
+
+			if ($publishPages) {
+				$record->publishRecursive();
+			}
+		}
+	}
+
+	/**
+	 * Imports a document at a certain path onto the current page and writes it.
+	 * CAUTION: Overwrites any existing content on the page!
+	 *
+	 * @param array $tmpFile Array as received from PHP's POST upload.
+	 * @param bool $splitHeader Heading level to split by.
+	 * @param bool $publishPages Whether the underlying pages should be published after import.
+	 * @param int $chosenFolderID ID of the working folder - here the converted file and images will be stored.
+	 */
+	public function importFromPOST($tmpFile, $splitHeader = false, $publishPages = false, $chosenFolderID = null)
+	{
+
+		$fileDescriptor = [
+			'name' => $tmpFile['name'],
+			'path' => $tmpFile['tmp_name'],
+			'mimeType' => $tmpFile['type']
+		];
+
+		$sourcePage = $this->form->getRecord();
+		$importerClass = $this->config()->get('importer_class');
+		$importer = Injector::inst()->create($importerClass, $fileDescriptor, $chosenFolderID);
+		$content = $importer->import();
+
+		if (is_array($content) && isset($content['error'])) {
+			return $content;
+		}
+
+		// Clean up with tidy (requires tidy module)
+		$tidy = new Tidy();
+		$tidy->parseString($content, ['output-xhtml' => true], 'utf8');
+		$tidy->cleanRepair();
+
+		$fragment = [];
+		foreach ($tidy->body()->child as $child) {
+			$fragment[] = $child->value;
+		}
+
+		$htmlValue = Injector::inst()->create(HTMLValue::class, implode("\n", $fragment));
+
+		// Sanitise
+		$santiser = Injector::inst()->create(HTMLEditorSanitiser::class, HTMLEditorConfig::get_active());
+		$santiser->sanitise($htmlValue);
+
+		// Load in the HTML
+		$doc = $htmlValue->getDocument();
+		$xpath = new DOMXPath($doc);
+
+		// make sure any images are added as Image records with a relative link to assets
+		$chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
+		$folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
+		$imgs = $xpath->query('//img');
+		for ($i = 0; $i < $imgs->length; $i++) {
+			$img = $imgs->item($i);
+			$originalPath = 'assets/' . $folderName . '/' . $img->getAttribute('src');
+			$name = FileNameFilter::create()->filter(basename($originalPath));
+
+			$image = Image::get()->filter([
+				'Name' => $name,
+				'ParentID' => (int)$chosenFolderID
+			])->first();
+			if (!($image && $image->exists())) {
+				$image = Image::create();
+				$image->ParentID = (int)$chosenFolderID;
+				$image->Name = $name;
+				$image->write();
+			}
+
+			// make sure it's put in place correctly so Image record knows where it is.
+			// e.g. in the case of underscores being renamed to dashes.
+			@rename(Director::getAbsFile($originalPath), Director::getAbsFile($image->getFilename()));
+
+			$img->setAttribute('src', $image->getFilename());
+		}
+
+		$remove_rules = [
+			// Change any headers that contain font tags (other than font face tags) into p elements
+			'//h1[.//font[not(@face)]]' => 'p',
+			// Remove any font tags
+			'//font'
+		];
+
+		foreach ($remove_rules as $rule => $parenttag) {
+			if (is_numeric($rule)) {
+				$rule = $parenttag;
+				$parenttag = null;
+			}
+
+			$nodes = [];
+			foreach ($xpath->query($rule) as $node) {
+				$nodes[] = $node;
+			}
+
+			foreach ($nodes as $node) {
+				$parent = $node->parentNode;
+
+				if ($parenttag) {
+					$parent = $doc->createElement($parenttag);
+					$node->nextSibling ?
+						$node->parentNode->insertBefore($parent, $node->nextSibling) :
+						$node->parentNode->appendChild($parent);
+				}
+
+				while ($node->firstChild) {
+					$parent->appendChild($node->firstChild);
+				}
+				$node->parentNode->removeChild($node);
+			}
+		}
+
+		// Strip style, class, lang attributes.
+		$els = $doc->getElementsByTagName('*');
+		for ($i = 0; $i < $els->length; $i++) {
+			$el = $els->item($i);
+			$el->removeAttribute('class');
+			$el->removeAttribute('style');
+			$el->removeAttribute('lang');
+		}
+
+		$els = $doc->getElementsByTagName('*');
+
+		$headingXPath = [
+			'self::h1',
+			'self::h2',
+			'self::h3',
+			'self::h4',
+			'self::h5',
+			'self::h6',
+		];
+		// Remove a bunch of unwanted elements
+		$clean = [
+			// Empty paragraphs
+			'//p[not(descendant-or-self::text() | descendant-or-self::img)]',
+			// Empty headers
+			'//*[' . implode(' | ', $headingXPath) . '][not(descendant-or-self::text() | descendant-or-self::img)]',
+			// Anchors
+			'//a[not(@href)]',
+			// BR tags
+			'//br'
+		];
+
+		foreach ($clean as $query) {
+			// First get all the nodes. Need to build array, as they'll disappear from the
+			// nodelist while we're deleteing them, causing the indexing to screw up.
+			$nodes = [];
+			foreach ($xpath->query($query) as $node) {
+				$nodes[] = $node;
+			}
+
+			// Then remove them all
+			foreach ($nodes as $node) {
+				if ($node->parentNode) {
+					$node->parentNode->removeChild($node);
+				}
+			}
+		}
+
+		// Now split the document into portions by H1
+		$body = $doc->getElementsByTagName('body')->item(0);
+
+		$this->unusedChildren = [];
+		foreach ($sourcePage->Children() as $child) {
+			$this->unusedChildren[$child->ID] = $child;
+		}
+
+		$documentImporterFieldError = false;
+
+		$documentImporterFieldErrorHandler = function (
+			$errno,
+			$errstr,
+			$errfile,
+			$errline
+		) use ($documentImporterFieldError) {
+			$documentImporterFieldError = _t(
+				'SilverStripe\\DocumentConverter\\ServiceConnector.PROCESSFAILED',
+				'Could not process document, please double-check you uploaded a .doc or .docx format.',
+				'Document Converter processes Word documents into HTML.'
+			);
+
+			// Do not cascade the error through other handlers
+			return true;
+		};
+
+		set_error_handler($documentImporterFieldErrorHandler);
+
+		$subtitle = null;
+		$subdoc = new DOMDocument();
+		$subnode = $subdoc->createElement('body');
+		$node = $body->firstChild;
+		$sort = 1;
+		if ($splitHeader == 1 || $splitHeader == 2) {
+			while ($node && !$documentImporterFieldError) {
+				if ($node instanceof DOMElement && $node->tagName == 'h' . $splitHeader) {
+					if ($subnode->hasChildNodes()) {
+						$this->writeContent($subtitle, $subdoc, $subnode, $sort, $publishPages);
+						$sort++;
+					}
+
+					$subdoc = new DOMDocument();
+					$subnode = $subdoc->createElement('body');
+					$subtitle = trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent)));
+				} else {
+					$subnode->appendChild($subdoc->importNode($node, true));
+				}
+
+				$node = $node->nextSibling;
+			}
+		} else {
+			$this->writeContent($subtitle, $subdoc, $body, null, $publishPages);
+		}
+
+		if ($subnode->hasChildNodes() && !$documentImporterFieldError) {
+			$this->writeContent($subtitle, $subdoc, $subnode, null, $publishPages);
+		}
+
+		restore_error_handler();
+		if ($documentImporterFieldError) {
+			return ['error' => $documentImporterFieldError];
+		}
+
+		foreach ($this->unusedChildren as $child) {
+			$origStage = Versioned::current_stage();
+
+			Versioned::set_stage(Versioned::DRAFT);
+			$draft = clone $child;
+			$draft->delete();
+
+			Versioned::set_stage(Versioned::LIVE);
+			$published = clone $child;
+			$published->delete();
+
+			Versioned::set_stage($origStage);
+		}
+
+		$sourcePage->write();
+	}
 }

tests/SettingsFieldTest.php

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
         ];
         foreach ($settingsFields as $fieldName => $className) {
             $field = $fields->fieldByName(
-                'DocumentConversionSettings-' . $fieldName
+                'DocumentConversionSettings-'.$fieldName
             );
             $this->assertInstanceOf($className, $field);
             $this->assertContains('no-change-track', $field->extraClass());

Indentation +49 added lines, -49 removed lines

@@ -15,61 +15,61 @@
 
 class SettingsFieldTest extends SapphireTest
 {
-    /**
-     * @expectedException InvalidArgumentException
-     */
-    public function testConstructorThrowsExceptionWhenGivenString()
-    {
-        new SettingsField('exception time!');
-    }
+	/**
+	 * @expectedException InvalidArgumentException
+	 */
+	public function testConstructorThrowsExceptionWhenGivenString()
+	{
+		new SettingsField('exception time!');
+	}
 
-    /**
-     * @expectedException InvalidArgumentException
-     */
-    public function testConstructorThrowsExceptionWhenGivenChildren()
-    {
-        new SettingsField(['i', 'don\'t', 'like', 'kids']);
-    }
+	/**
+	 * @expectedException InvalidArgumentException
+	 */
+	public function testConstructorThrowsExceptionWhenGivenChildren()
+	{
+		new SettingsField(['i', 'don\'t', 'like', 'kids']);
+	}
 
-    public function testFieldAddsJavascriptRequirements()
-    {
-        // Start with a clean slate (no global state interference)
-        Requirements::backend()->clear();
+	public function testFieldAddsJavascriptRequirements()
+	{
+		// Start with a clean slate (no global state interference)
+		Requirements::backend()->clear();
 
-        new SettingsField();
-        $javascript = Requirements::backend()->getJavascript();
-        $this->assertNotEmpty($javascript);
-    }
+		new SettingsField();
+		$javascript = Requirements::backend()->getJavascript();
+		$this->assertNotEmpty($javascript);
+	}
 
-    public function testFieldListGeneration()
-    {
-        $importField = new SettingsField();
+	public function testFieldListGeneration()
+	{
+		$importField = new SettingsField();
 
-        $fields = $importField->getChildren();
-        $this->assertInstanceOf(FieldList::class, $fields);
+		$fields = $importField->getChildren();
+		$this->assertInstanceOf(FieldList::class, $fields);
 
-        // We don't need to check that all of the fields are there, but just check a couple
-        $this->assertInstanceOf(LiteralField::class, $fields->fieldByName('FileWarningHeader'));
-        $innerField = $fields->fieldByName('ImportedFromFile');
-        $this->assertInstanceOf(ImportField::class, $innerField);
+		// We don't need to check that all of the fields are there, but just check a couple
+		$this->assertInstanceOf(LiteralField::class, $fields->fieldByName('FileWarningHeader'));
+		$innerField = $fields->fieldByName('ImportedFromFile');
+		$this->assertInstanceOf(ImportField::class, $innerField);
 
-        // Check the getter works
-        $this->assertSame($innerField, $importField->getInnerField());
+		// Check the getter works
+		$this->assertSame($innerField, $importField->getInnerField());
 
-        // Check the fields have been given has the change tracker disabled
-        $settingsFields = [
-            'SplitHeader' => DropdownField::class,
-            'KeepSource' => CheckboxField::class,
-            'ChosenFolderID' => TreeDropdownField::class,
-            'IncludeTOC' => CheckboxField::class,
-            'PublishPages' => CheckboxField::class
-        ];
-        foreach ($settingsFields as $fieldName => $className) {
-            $field = $fields->fieldByName(
-                'DocumentConversionSettings-' . $fieldName
-            );
-            $this->assertInstanceOf($className, $field);
-            $this->assertContains('no-change-track', $field->extraClass());
-        }
-    }
+		// Check the fields have been given has the change tracker disabled
+		$settingsFields = [
+			'SplitHeader' => DropdownField::class,
+			'KeepSource' => CheckboxField::class,
+			'ChosenFolderID' => TreeDropdownField::class,
+			'IncludeTOC' => CheckboxField::class,
+			'PublishPages' => CheckboxField::class
+		];
+		foreach ($settingsFields as $fieldName => $className) {
+			$field = $fields->fieldByName(
+				'DocumentConversionSettings-' . $fieldName
+			);
+			$this->assertInstanceOf($className, $field);
+			$this->assertContains('no-change-track', $field->extraClass());
+		}
+	}
 }

tests/Stubs/MockDocvertService.php

Indentation +4 added lines, -4 removed lines

@@ -7,8 +7,8 @@
 
 class MockDocvertService extends ServiceConnector implements TestOnly
 {
-    public function import()
-    {
-        return '<h1>Fake document</h1><p>For testing purposes.</p>';
-    }
+	public function import()
+	{
+		return '<h1>Fake document</h1><p>For testing purposes.</p>';
+	}
 }

src/PageExtension.php

Spacing +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
          */
         $fields->findOrMakeTab(
             'Root.Import',
-            _t(__CLASS__ . '.ImportTab', 'Import')
+            _t(__CLASS__.'.ImportTab', 'Import')
         );
         $fields->addFieldToTab('Root.Import', SettingsField::create());
     }

Indentation +12 added lines, -12 removed lines

@@ -9,13 +9,13 @@ 
 class PageExtension extends DataExtension
 {
 
-    private static $has_one = [
-        'ImportedFromFile' => File::class
-    ];
+	private static $has_one = [
+		'ImportedFromFile' => File::class
+	];
 
-    public function updateCMSFields(FieldList $fields)
-    {
-        /*
+	public function updateCMSFields(FieldList $fields)
+	{
+		/*
         // Currently the ToggleCompositeField plays badly with TreeDropdownField formatting.
         // Could be switched back in the future, if this is fixed.
         $fields->addFieldToTab('Root.Main',
@@ -24,10 +24,10 @@ 
             ])->setHeadingLevel(4)
         );
          */
-        $fields->findOrMakeTab(
-            'Root.Import',
-            _t(__CLASS__ . '.ImportTab', 'Import')
-        );
-        $fields->addFieldToTab('Root.Import', SettingsField::create());
-    }
+		$fields->findOrMakeTab(
+			'Root.Import',
+			_t(__CLASS__ . '.ImportTab', 'Import')
+		);
+		$fields->addFieldToTab('Root.Import', SettingsField::create());
+	}
 }

src/ServiceConnector.php

Indentation +177 added lines, -177 removed lines

@@ -16,182 +16,182 @@
 class ServiceConnector
 {
 
-    use Configurable;
-    use Injectable;
-
-    /**
-     * @config
-     * @var array Docvert connection username
-     */
-    private static $username = null;
-
-    /**
-     * @config
-     * @var array Docvert connection password
-     */
-    private static $password = null;
-
-    /**
-     * @config
-     * @var array Docvert service URL
-     */
-    private static $url = null;
-
-    /**
-     * Associative array of:
-     * - name: the full name of the file including the extension.
-     * - path: the path to the file on the local filesystem.
-     * - mimeType
-     */
-    protected $fileDescriptor;
-
-    /**
-     * @var int
-     * ID of a SilverStripe\Assets\Folder
-     */
-    protected $chosenFolderID;
-
-    /**
-     * @var array instance specific connection details
-     */
-    protected $docvertDetails = [
-        'username' => null,
-        'password' => null,
-        'url' => null
-    ];
-
-    public function __construct($fileDescriptor, $chosenFolderID = null)
-    {
-        $this->fileDescriptor = $fileDescriptor;
-        $this->chosenFolderID = $chosenFolderID;
-    }
-
-
-    /**
-     * Retrieves detail in priority order from
-     * 1. local instance field
-     * 2. Config
-     * 3. Environment
-     *
-     * @param string $detail key name for detail
-     * @return string the value for that key
-     */
-    protected function getDetail($detail)
-    {
-        $fromDetails = $this->docvertDetails[$detail];
-        if ($fromDetails) {
-            return $fromDetails;
-        }
+	use Configurable;
+	use Injectable;
+
+	/**
+	 * @config
+	 * @var array Docvert connection username
+	 */
+	private static $username = null;
+
+	/**
+	 * @config
+	 * @var array Docvert connection password
+	 */
+	private static $password = null;
+
+	/**
+	 * @config
+	 * @var array Docvert service URL
+	 */
+	private static $url = null;
+
+	/**
+	 * Associative array of:
+	 * - name: the full name of the file including the extension.
+	 * - path: the path to the file on the local filesystem.
+	 * - mimeType
+	 */
+	protected $fileDescriptor;
+
+	/**
+	 * @var int
+	 * ID of a SilverStripe\Assets\Folder
+	 */
+	protected $chosenFolderID;
+
+	/**
+	 * @var array instance specific connection details
+	 */
+	protected $docvertDetails = [
+		'username' => null,
+		'password' => null,
+		'url' => null
+	];
+
+	public function __construct($fileDescriptor, $chosenFolderID = null)
+	{
+		$this->fileDescriptor = $fileDescriptor;
+		$this->chosenFolderID = $chosenFolderID;
+	}
+
+
+	/**
+	 * Retrieves detail in priority order from
+	 * 1. local instance field
+	 * 2. Config
+	 * 3. Environment
+	 *
+	 * @param string $detail key name for detail
+	 * @return string the value for that key
+	 */
+	protected function getDetail($detail)
+	{
+		$fromDetails = $this->docvertDetails[$detail];
+		if ($fromDetails) {
+			return $fromDetails;
+		}
         
-        $fromConfig = $this->config()->get($detail);
-        if ($fromConfig) {
-            return $fromConfig;
-        }
-
-        $fromEnv = Environment::getEnv('DOCVERT_' . strtoupper($detail));
-        if ($fromEnv) {
-            return $fromEnv;
-        }
-    }
-
-    public function setUsername($username = null)
-    {
-        $this->docvertDetails['username'] = $username;
-        return $this;
-    }
-
-    public function getUsername()
-    {
-        return $this->getDetail('username');
-    }
-
-    public function setPassword($password = null)
-    {
-        $this->docvertDetails['password'] = $password;
-        return $this;
-    }
-
-    public function getPassword()
-    {
-        return $this->getDetail('password');
-    }
-
-    public function setUrl($url = null)
-    {
-        $this->docvertDetails['url'] = $url;
-        return $this;
-    }
-
-    public function getUrl()
-    {
-        return $this->getDetail('url');
-    }
-
-    public function import()
-    {
-        $ch = curl_init();
-
-        $file = new CURLFile(
-            $this->fileDescriptor['path'],
-            $this->fileDescriptor['mimeType'],
-            $this->fileDescriptor['name']
-        );
-
-        curl_setopt_array($ch, [
-            CURLOPT_URL => $this->getUrl(),
-            CURLOPT_USERPWD => sprintf('%s:%s', $this->getUsername(), $this->getPassword()),
-            CURLOPT_POST => 1,
-            CURLOPT_POSTFIELDS => ['file' => $file],
-            CURLOPT_CONNECTTIMEOUT => 25,
-            CURLOPT_TIMEOUT => 100,
-        ]);
-
-        $chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
-        $folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
-        $outname = tempnam(ASSETS_PATH, 'convert');
-        $outzip = $outname . '.zip';
-        $out = fopen($outzip, 'w');
-        curl_setopt($ch, CURLOPT_FILE, $out);
-        $returnValue = curl_exec($ch);
-        $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
-        curl_close($ch);
-        fclose($out);
-        chmod($outzip, 0666);
-
-        if (!$returnValue || ($status != 200)) {
-            return ['error' => _t(
-                __CLASS__ . '.SERVERUNREACHABLE',
-                'Could not contact document conversion server. Please try again later ' .
-                    'or contact your system administrator.',
-                'Document Converter process Word documents into HTML.'
-            )];
-        }
-
-        // extract the converted document into assets
-        // you need php zip, e.g. apt-get install php-zip
-        $zip = new ZipArchive();
-
-        if ($zip->open($outzip)) {
-            $zip->extractTo(ASSETS_PATH .$folderName);
-            $zip->close();
-        }
-
-        // remove temporary files
-        unlink($outname);
-        unlink($outzip);
-
-        if (!file_exists(ASSETS_PATH . $folderName . '/index.html')) {
-            return ['error' =>  _t(
-                __CLASS__ . '.PROCESSFAILED',
-                'Could not process document, please double-check you uploaded a .doc or .docx format.',
-                'Document Converter processes Word documents into HTML.'
-            )];
-        }
-
-        $content = file_get_contents(ASSETS_PATH . $folderName . '/index.html');
-
-        unlink(ASSETS_PATH . $folderName . '/index.html');
-
-        return $content;
-    }
+		$fromConfig = $this->config()->get($detail);
+		if ($fromConfig) {
+			return $fromConfig;
+		}
+
+		$fromEnv = Environment::getEnv('DOCVERT_' . strtoupper($detail));
+		if ($fromEnv) {
+			return $fromEnv;
+		}
+	}
+
+	public function setUsername($username = null)
+	{
+		$this->docvertDetails['username'] = $username;
+		return $this;
+	}
+
+	public function getUsername()
+	{
+		return $this->getDetail('username');
+	}
+
+	public function setPassword($password = null)
+	{
+		$this->docvertDetails['password'] = $password;
+		return $this;
+	}
+
+	public function getPassword()
+	{
+		return $this->getDetail('password');
+	}
+
+	public function setUrl($url = null)
+	{
+		$this->docvertDetails['url'] = $url;
+		return $this;
+	}
+
+	public function getUrl()
+	{
+		return $this->getDetail('url');
+	}
+
+	public function import()
+	{
+		$ch = curl_init();
+
+		$file = new CURLFile(
+			$this->fileDescriptor['path'],
+			$this->fileDescriptor['mimeType'],
+			$this->fileDescriptor['name']
+		);
+
+		curl_setopt_array($ch, [
+			CURLOPT_URL => $this->getUrl(),
+			CURLOPT_USERPWD => sprintf('%s:%s', $this->getUsername(), $this->getPassword()),
+			CURLOPT_POST => 1,
+			CURLOPT_POSTFIELDS => ['file' => $file],
+			CURLOPT_CONNECTTIMEOUT => 25,
+			CURLOPT_TIMEOUT => 100,
+		]);
+
+		$chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
+		$folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
+		$outname = tempnam(ASSETS_PATH, 'convert');
+		$outzip = $outname . '.zip';
+		$out = fopen($outzip, 'w');
+		curl_setopt($ch, CURLOPT_FILE, $out);
+		$returnValue = curl_exec($ch);
+		$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+		curl_close($ch);
+		fclose($out);
+		chmod($outzip, 0666);
+
+		if (!$returnValue || ($status != 200)) {
+			return ['error' => _t(
+				__CLASS__ . '.SERVERUNREACHABLE',
+				'Could not contact document conversion server. Please try again later ' .
+					'or contact your system administrator.',
+				'Document Converter process Word documents into HTML.'
+			)];
+		}
+
+		// extract the converted document into assets
+		// you need php zip, e.g. apt-get install php-zip
+		$zip = new ZipArchive();
+
+		if ($zip->open($outzip)) {
+			$zip->extractTo(ASSETS_PATH .$folderName);
+			$zip->close();
+		}
+
+		// remove temporary files
+		unlink($outname);
+		unlink($outzip);
+
+		if (!file_exists(ASSETS_PATH . $folderName . '/index.html')) {
+			return ['error' =>  _t(
+				__CLASS__ . '.PROCESSFAILED',
+				'Could not process document, please double-check you uploaded a .doc or .docx format.',
+				'Document Converter processes Word documents into HTML.'
+			)];
+		}
+
+		$content = file_get_contents(ASSETS_PATH . $folderName . '/index.html');
+
+		unlink(ASSETS_PATH . $folderName . '/index.html');
+
+		return $content;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -88,7 +88,7 @@ 
             return $fromConfig;
         }
 
-        $fromEnv = Environment::getEnv('DOCVERT_' . strtoupper($detail));
+        $fromEnv = Environment::getEnv('DOCVERT_'.strtoupper($detail));
         if ($fromEnv) {
             return $fromEnv;
         }
@@ -147,9 +147,9 @@ 
         ]);
 
         $chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
-        $folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
+        $folderName = ($chosenFolder) ? '/'.$chosenFolder->Name : '';
         $outname = tempnam(ASSETS_PATH, 'convert');
-        $outzip = $outname . '.zip';
+        $outzip = $outname.'.zip';
         $out = fopen($outzip, 'w');
         curl_setopt($ch, CURLOPT_FILE, $out);
         $returnValue = curl_exec($ch);
@@ -160,8 +160,8 @@ 
 
         if (!$returnValue || ($status != 200)) {
             return ['error' => _t(
-                __CLASS__ . '.SERVERUNREACHABLE',
-                'Could not contact document conversion server. Please try again later ' .
+                __CLASS__.'.SERVERUNREACHABLE',
+                'Could not contact document conversion server. Please try again later '.
                     'or contact your system administrator.',
                 'Document Converter process Word documents into HTML.'
             )];
@@ -172,7 +172,7 @@ 
         $zip = new ZipArchive();
 
         if ($zip->open($outzip)) {
-            $zip->extractTo(ASSETS_PATH .$folderName);
+            $zip->extractTo(ASSETS_PATH.$folderName);
             $zip->close();
         }
 
@@ -180,17 +180,17 @@ 
         unlink($outname);
         unlink($outzip);
 
-        if (!file_exists(ASSETS_PATH . $folderName . '/index.html')) {
+        if (!file_exists(ASSETS_PATH.$folderName.'/index.html')) {
             return ['error' =>  _t(
-                __CLASS__ . '.PROCESSFAILED',
+                __CLASS__.'.PROCESSFAILED',
                 'Could not process document, please double-check you uploaded a .doc or .docx format.',
                 'Document Converter processes Word documents into HTML.'
             )];
         }
 
-        $content = file_get_contents(ASSETS_PATH . $folderName . '/index.html');
+        $content = file_get_contents(ASSETS_PATH.$folderName.'/index.html');
 
-        unlink(ASSETS_PATH . $folderName . '/index.html');
+        unlink(ASSETS_PATH.$folderName.'/index.html');
 
         return $content;
     }

tests/Stubs/TestPage.php

Indentation +5 added lines, -5 removed lines

@@ -8,9 +8,9 @@
 
 class TestPage extends Page implements TestOnly
 {
-    private static $table_name = 'DocvertTestPage';
-    private static $extensions = [PageExtension::class];
-    private static $defaults = [
-        'Content' => '<h1>Default TestPage</h1><p>With pre-import content.</p>'
-    ];
+	private static $table_name = 'DocvertTestPage';
+	private static $extensions = [PageExtension::class];
+	private static $defaults = [
+		'Content' => '<h1>Default TestPage</h1><p>With pre-import content.</p>'
+	];
 }

src/SettingsField.php

Indentation +80 added lines, -80 removed lines

@@ -20,90 +20,90 @@
  */
 class SettingsField extends CompositeField
 {
-    /**
-     * Reference to the inner upload field (ImportField).
-     */
-    private $innerField = null;
+	/**
+	 * Reference to the inner upload field (ImportField).
+	 */
+	private $innerField = null;
 
-    /**
-     * Augments a simple CompositeField with uploader and import options.
-     *
-     * @param $children FieldSet/array Any additional children.
-     */
-    public function __construct($children = null)
-    {
-        if ($children) {
-            $class = get_class();
-            throw new InvalidArgumentException(
-                "${class}::__construct does not accept extra parameters."
-            );
-        }
+	/**
+	 * Augments a simple CompositeField with uploader and import options.
+	 *
+	 * @param $children FieldSet/array Any additional children.
+	 */
+	public function __construct($children = null)
+	{
+		if ($children) {
+			$class = get_class();
+			throw new InvalidArgumentException(
+				"${class}::__construct does not accept extra parameters."
+			);
+		}
 
-        // Add JS specific to this field.
-        Requirements::javascript('silverstripe/documentconverter: javascript/DocumentConversionField.js');
+		// Add JS specific to this field.
+		Requirements::javascript('silverstripe/documentconverter: javascript/DocumentConversionField.js');
 
-        $fields = FieldList::create([
-            LiteralField::create(
-                'FileWarningHeader',
-                '<div class="alert alert-warning">' . _t(
-                    __CLASS__ . '.FileWarningHeader',
-                    'Warning: import will remove all content and subpages of this page.'
-                ) . '</div>',
-                4
-            ),
-            $splitHeader = DropdownField::create(
-                'DocumentConversionSettings-SplitHeader',
-                _t(
-                    __CLASS__ . '.SplitHeader',
-                    'Split document into pages'
-                ),
-                [
-                    0 => _t(__CLASS__ . '.No', 'no'),
-                    1 => _t(__CLASS__ . '.EachH1', 'for each heading 1'),
-                    2 => _t(__CLASS__ . '.EachH2', 'for each heading 2')
-                ]
-            ),
-            $keepSource = CheckboxField::create(
-                'DocumentConversionSettings-KeepSource',
-                _t(
-                    __CLASS__ . '.KeepSource',
-                    'Keep the original document. Adds a link to it on TOC, if enabled.'
-                )
-            ),
-            $chosenFolderID = TreeDropdownField::create(
-                'DocumentConversionSettings-ChosenFolderID',
-                _t(__CLASS__ . '.ChooseFolder', 'Choose a folder to save this file'),
-                Folder::class
-            ),
-            $includeTOC = CheckboxField::create(
-                'DocumentConversionSettings-IncludeTOC',
-                _t(__CLASS__ . '.IncludeTOC', 'Replace this page with a Table of Contents.')
-            ),
-            $publishPages = CheckboxField::create(
-                'DocumentConversionSettings-PublishPages',
-                _t(
-                    __CLASS__ . '.publishPages',
-                    'Publish modified pages (not recommended unless you are sure about the conversion outcome)'
-                )
-            ),
-            $this->innerField = ImportField::create(
-                'ImportedFromFile',
-                _t(__CLASS__ . '.ImportedFromFile', 'Import content from a word document')
-            )
-        ]);
+		$fields = FieldList::create([
+			LiteralField::create(
+				'FileWarningHeader',
+				'<div class="alert alert-warning">' . _t(
+					__CLASS__ . '.FileWarningHeader',
+					'Warning: import will remove all content and subpages of this page.'
+				) . '</div>',
+				4
+			),
+			$splitHeader = DropdownField::create(
+				'DocumentConversionSettings-SplitHeader',
+				_t(
+					__CLASS__ . '.SplitHeader',
+					'Split document into pages'
+				),
+				[
+					0 => _t(__CLASS__ . '.No', 'no'),
+					1 => _t(__CLASS__ . '.EachH1', 'for each heading 1'),
+					2 => _t(__CLASS__ . '.EachH2', 'for each heading 2')
+				]
+			),
+			$keepSource = CheckboxField::create(
+				'DocumentConversionSettings-KeepSource',
+				_t(
+					__CLASS__ . '.KeepSource',
+					'Keep the original document. Adds a link to it on TOC, if enabled.'
+				)
+			),
+			$chosenFolderID = TreeDropdownField::create(
+				'DocumentConversionSettings-ChosenFolderID',
+				_t(__CLASS__ . '.ChooseFolder', 'Choose a folder to save this file'),
+				Folder::class
+			),
+			$includeTOC = CheckboxField::create(
+				'DocumentConversionSettings-IncludeTOC',
+				_t(__CLASS__ . '.IncludeTOC', 'Replace this page with a Table of Contents.')
+			),
+			$publishPages = CheckboxField::create(
+				'DocumentConversionSettings-PublishPages',
+				_t(
+					__CLASS__ . '.publishPages',
+					'Publish modified pages (not recommended unless you are sure about the conversion outcome)'
+				)
+			),
+			$this->innerField = ImportField::create(
+				'ImportedFromFile',
+				_t(__CLASS__ . '.ImportedFromFile', 'Import content from a word document')
+			)
+		]);
 
-        // Prevent the warning popup that appears when navigating away from the page.
-        $splitHeader->addExtraClass('no-change-track');
-        $keepSource->addExtraClass('no-change-track');
-        $chosenFolderID->addExtraClass('no-change-track');
-        $includeTOC->addExtraClass('no-change-track');
-        $publishPages->addExtraClass('no-change-track');
+		// Prevent the warning popup that appears when navigating away from the page.
+		$splitHeader->addExtraClass('no-change-track');
+		$keepSource->addExtraClass('no-change-track');
+		$chosenFolderID->addExtraClass('no-change-track');
+		$includeTOC->addExtraClass('no-change-track');
+		$publishPages->addExtraClass('no-change-track');
 
-        return parent::__construct($fields);
-    }
+		return parent::__construct($fields);
+	}
 
-    public function getInnerField()
-    {
-        return $this->innerField;
-    }
+	public function getInnerField()
+	{
+		return $this->innerField;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -45,50 +45,50 @@
         $fields = FieldList::create([
             LiteralField::create(
                 'FileWarningHeader',
-                '<div class="alert alert-warning">' . _t(
-                    __CLASS__ . '.FileWarningHeader',
+                '<div class="alert alert-warning">'._t(
+                    __CLASS__.'.FileWarningHeader',
                     'Warning: import will remove all content and subpages of this page.'
-                ) . '</div>',
+                ).'</div>',
                 4
             ),
             $splitHeader = DropdownField::create(
                 'DocumentConversionSettings-SplitHeader',
                 _t(
-                    __CLASS__ . '.SplitHeader',
+                    __CLASS__.'.SplitHeader',
                     'Split document into pages'
                 ),
                 [
-                    0 => _t(__CLASS__ . '.No', 'no'),
-                    1 => _t(__CLASS__ . '.EachH1', 'for each heading 1'),
-                    2 => _t(__CLASS__ . '.EachH2', 'for each heading 2')
+                    0 => _t(__CLASS__.'.No', 'no'),
+                    1 => _t(__CLASS__.'.EachH1', 'for each heading 1'),
+                    2 => _t(__CLASS__.'.EachH2', 'for each heading 2')
                 ]
             ),
             $keepSource = CheckboxField::create(
                 'DocumentConversionSettings-KeepSource',
                 _t(
-                    __CLASS__ . '.KeepSource',
+                    __CLASS__.'.KeepSource',
                     'Keep the original document. Adds a link to it on TOC, if enabled.'
                 )
             ),
             $chosenFolderID = TreeDropdownField::create(
                 'DocumentConversionSettings-ChosenFolderID',
-                _t(__CLASS__ . '.ChooseFolder', 'Choose a folder to save this file'),
+                _t(__CLASS__.'.ChooseFolder', 'Choose a folder to save this file'),
                 Folder::class
             ),
             $includeTOC = CheckboxField::create(
                 'DocumentConversionSettings-IncludeTOC',
-                _t(__CLASS__ . '.IncludeTOC', 'Replace this page with a Table of Contents.')
+                _t(__CLASS__.'.IncludeTOC', 'Replace this page with a Table of Contents.')
             ),
             $publishPages = CheckboxField::create(
                 'DocumentConversionSettings-PublishPages',
                 _t(
-                    __CLASS__ . '.publishPages',
+                    __CLASS__.'.publishPages',
                     'Publish modified pages (not recommended unless you are sure about the conversion outcome)'
                 )
             ),
             $this->innerField = ImportField::create(
                 'ImportedFromFile',
-                _t(__CLASS__ . '.ImportedFromFile', 'Import content from a word document')
+                _t(__CLASS__.'.ImportedFromFile', 'Import content from a word document')
             )
         ]);