@@ -28,240 +28,240 @@ |
||
| 28 | 28 | |
| 29 | 29 | class BasePage extends SiteTree |
| 30 | 30 | { |
| 31 | - private static $icon = 'cwp/cwp:images/icons/sitetree_images/page.png'; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Hide this page type from the CMS. hide_ancestor is slightly misnamed, should really be just "hide" |
|
| 35 | - * |
|
| 36 | - * {@inheritDoc} |
|
| 37 | - */ |
|
| 38 | - private static $hide_ancestor = BasePage::class; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @config |
|
| 42 | - * @var bool |
|
| 43 | - */ |
|
| 44 | - private static $pdf_export = false; |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * Domain to generate PDF's from, DOES not include protocol |
|
| 48 | - * i.e. google.com not http://google.com |
|
| 49 | - * @config |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 52 | - private static $pdf_base_url = ""; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Allow custom overriding of the path to the WKHTMLTOPDF binary, in cases |
|
| 56 | - * where multiple versions of the binary are available to choose from. This |
|
| 57 | - * should be the full path to the binary (e.g. /usr/local/bin/wkhtmltopdf) |
|
| 58 | - * @see BasePage_Controller::generatePDF(); |
|
| 59 | - * |
|
| 60 | - * @config |
|
| 61 | - * @var string|null |
|
| 62 | - */ |
|
| 63 | - private static $wkhtmltopdf_binary = null; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Where to store generated PDF files |
|
| 67 | - * |
|
| 68 | - * @config |
|
| 69 | - * @var string |
|
| 70 | - */ |
|
| 71 | - private static $generated_pdf_path = 'assets/_generated_pdfs'; |
|
| 72 | - |
|
| 73 | - private static $api_access = [ |
|
| 74 | - 'view' => [ |
|
| 75 | - 'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription', |
|
| 76 | - 'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID' |
|
| 77 | - ], |
|
| 78 | - 'edit' => [ |
|
| 79 | - 'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription', |
|
| 80 | - 'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID' |
|
| 81 | - ], |
|
| 82 | - ]; |
|
| 83 | - |
|
| 84 | - private static $table_name = 'BasePage'; |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * @config |
|
| 88 | - * @var string |
|
| 89 | - */ |
|
| 90 | - private static $related_pages_title = 'Related pages'; |
|
| 91 | - |
|
| 92 | - private static $many_many = [ |
|
| 93 | - 'Terms' => TaxonomyTerm::class, |
|
| 94 | - 'RelatedPages' => BasePage::class, |
|
| 95 | - ]; |
|
| 96 | - |
|
| 97 | - private static $many_many_extraFields = [ |
|
| 98 | - 'RelatedPages' => [ |
|
| 99 | - 'SortOrder' => 'Int', |
|
| 100 | - ], |
|
| 101 | - ]; |
|
| 102 | - |
|
| 103 | - private static $plural_name = 'Base Pages'; |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * Get the footer holder. |
|
| 107 | - */ |
|
| 108 | - public function getFooter() |
|
| 109 | - { |
|
| 110 | - return FooterHolder::get_one(FooterHolder::class); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Return the full filename of the pdf file, including path & extension |
|
| 115 | - */ |
|
| 116 | - public function getPdfFilename() |
|
| 117 | - { |
|
| 118 | - $baseName = sprintf('%s-%s', $this->URLSegment, $this->ID); |
|
| 119 | - |
|
| 120 | - $folderPath = $this->config()->get('generated_pdf_path'); |
|
| 121 | - if ($folderPath[0] != '/') { |
|
| 122 | - $folderPath = BASE_PATH . '/' . $folderPath; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - return sprintf('%s/%s.pdf', $folderPath, $baseName); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * Build pdf link for template. |
|
| 130 | - */ |
|
| 131 | - public function PdfLink() |
|
| 132 | - { |
|
| 133 | - if (!$this->config()->get('pdf_export')) { |
|
| 134 | - return false; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - $path = $this->getPdfFilename(); |
|
| 138 | - |
|
| 139 | - if ((Versioned::get_stage() === Versioned::LIVE) && file_exists($path)) { |
|
| 140 | - return Director::baseURL() . preg_replace('#^/#', '', Director::makeRelative($path)); |
|
| 141 | - } |
|
| 142 | - return $this->Link('downloadpdf'); |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - public function RelatedPages() |
|
| 146 | - { |
|
| 147 | - return $this->getManyManyComponents('RelatedPages')->sort('SortOrder'); |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - public function RelatedPagesTitle() |
|
| 151 | - { |
|
| 152 | - return $this->config()->get('related_pages_title'); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Remove linked pdf when publishing the page, |
|
| 157 | - * as it would be out of date. |
|
| 158 | - */ |
|
| 159 | - public function onAfterPublish() |
|
| 160 | - { |
|
| 161 | - $filepath = $this->getPdfFilename(); |
|
| 162 | - if (file_exists($filepath)) { |
|
| 163 | - unlink($filepath); |
|
| 164 | - } |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * Remove linked pdf when unpublishing the page, |
|
| 169 | - * so it's no longer valid. |
|
| 170 | - * |
|
| 171 | - * @return boolean |
|
| 172 | - */ |
|
| 173 | - public function doUnpublish() |
|
| 174 | - { |
|
| 175 | - if (!parent::doUnpublish()) { |
|
| 176 | - return false; |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - $filepath = $this->getPdfFilename(); |
|
| 180 | - if (file_exists($filepath)) { |
|
| 181 | - unlink($filepath); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - return true; |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - public function getCMSFields() |
|
| 188 | - { |
|
| 189 | - $this->beforeUpdateCMSFields(function (FieldList $fields) { |
|
| 190 | - // Related Pages |
|
| 191 | - $components = GridFieldConfig_RelationEditor::create(); |
|
| 192 | - $components->removeComponentsByType(GridFieldAddNewButton::class); |
|
| 193 | - $components->removeComponentsByType(GridFieldEditButton::class); |
|
| 194 | - $components->removeComponentsByType(GridFieldFilterHeader::class); |
|
| 195 | - $components->addComponent(new GridFieldSortableRows('SortOrder')); |
|
| 196 | - |
|
| 197 | - /** @var GridFieldDataColumns $dataColumns */ |
|
| 198 | - $dataColumns = $components->getComponentByType(GridFieldDataColumns::class); |
|
| 199 | - $dataColumns->setDisplayFields([ |
|
| 200 | - 'Title' => _t(__CLASS__ . '.ColumnTitle', 'Title'), |
|
| 201 | - 'ClassName' => _t(__CLASS__ . '.ColumnPageType', 'Page Type') |
|
| 202 | - ]); |
|
| 203 | - |
|
| 204 | - $fields->findOrMakeTab( |
|
| 205 | - 'Root.RelatedPages', |
|
| 206 | - _t(__CLASS__ . '.RelatedPages', 'Related pages') |
|
| 207 | - ); |
|
| 208 | - $fields->addFieldToTab( |
|
| 209 | - 'Root.RelatedPages', |
|
| 210 | - GridField::create( |
|
| 211 | - 'RelatedPages', |
|
| 212 | - _t(__CLASS__ . '.RelatedPages', 'Related pages'), |
|
| 213 | - $this->RelatedPages(), |
|
| 214 | - $components |
|
| 215 | - ) |
|
| 216 | - ); |
|
| 217 | - |
|
| 218 | - // Taxonomies - Unless they have their own 'Tags' field (such as in Blog, etc) |
|
| 219 | - $hasMany = $this->hasMany(); |
|
| 220 | - $manyMany = $this->manyMany(); |
|
| 221 | - if (!isset($hasMany['Tags']) && !isset($manyMany['Tags'])) { |
|
| 222 | - $components = GridFieldConfig_RelationEditor::create(); |
|
| 223 | - $components->removeComponentsByType(GridFieldAddNewButton::class); |
|
| 224 | - $components->removeComponentsByType(GridFieldEditButton::class); |
|
| 225 | - |
|
| 226 | - /** @var GridFieldAddExistingAutocompleter $autoCompleter */ |
|
| 227 | - $autoCompleter = $components->getComponentByType(GridFieldAddExistingAutocompleter::class); |
|
| 228 | - $autoCompleter->setResultsFormat('$Name ($TaxonomyName)'); |
|
| 229 | - |
|
| 230 | - /** @var GridFieldDataColumns $dataColumns */ |
|
| 231 | - $dataColumns = $components->getComponentByType(GridFieldDataColumns::class); |
|
| 232 | - $dataColumns->setDisplayFields([ |
|
| 233 | - 'Name' => _t(__CLASS__ . '.Term', 'Term'), |
|
| 234 | - 'TaxonomyName' => _t(__CLASS__ . '.Taxonomy', 'Taxonomy') |
|
| 235 | - ]); |
|
| 236 | - |
|
| 237 | - $fields->findOrMakeTab('Root.Tags', _t(__CLASS__ . '.TagsTabTitle', 'Tags')); |
|
| 238 | - $fields->addFieldToTab( |
|
| 239 | - 'Root.Tags', |
|
| 240 | - TreeMultiselectField::create( |
|
| 241 | - 'Terms', |
|
| 242 | - _t(__CLASS__ . '.Terms', 'Terms'), |
|
| 243 | - TaxonomyTerm::class |
|
| 244 | - )->setDescription(_t(__CLASS__ . '.TermsDescription', 'Click to search for additional terms')) |
|
| 245 | - ); |
|
| 246 | - } |
|
| 247 | - }); |
|
| 248 | - return parent::getCMSFields(); |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * Returns the native language name for the selected locale/language, empty string if Fluent is not available |
|
| 253 | - * |
|
| 254 | - * @return string |
|
| 255 | - */ |
|
| 256 | - public function getSelectedLanguage() |
|
| 257 | - { |
|
| 258 | - if (!class_exists(Locale::class) || !$this->hasMethod('Locales')) { |
|
| 259 | - return ''; |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - /** @var ArrayData $information */ |
|
| 263 | - $information = $this->LocaleInformation(FluentState::singleton()->getLocale()); |
|
| 264 | - |
|
| 265 | - return $information->LanguageNative; |
|
| 266 | - } |
|
| 31 | + private static $icon = 'cwp/cwp:images/icons/sitetree_images/page.png'; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Hide this page type from the CMS. hide_ancestor is slightly misnamed, should really be just "hide" |
|
| 35 | + * |
|
| 36 | + * {@inheritDoc} |
|
| 37 | + */ |
|
| 38 | + private static $hide_ancestor = BasePage::class; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @config |
|
| 42 | + * @var bool |
|
| 43 | + */ |
|
| 44 | + private static $pdf_export = false; |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * Domain to generate PDF's from, DOES not include protocol |
|
| 48 | + * i.e. google.com not http://google.com |
|
| 49 | + * @config |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | + private static $pdf_base_url = ""; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Allow custom overriding of the path to the WKHTMLTOPDF binary, in cases |
|
| 56 | + * where multiple versions of the binary are available to choose from. This |
|
| 57 | + * should be the full path to the binary (e.g. /usr/local/bin/wkhtmltopdf) |
|
| 58 | + * @see BasePage_Controller::generatePDF(); |
|
| 59 | + * |
|
| 60 | + * @config |
|
| 61 | + * @var string|null |
|
| 62 | + */ |
|
| 63 | + private static $wkhtmltopdf_binary = null; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Where to store generated PDF files |
|
| 67 | + * |
|
| 68 | + * @config |
|
| 69 | + * @var string |
|
| 70 | + */ |
|
| 71 | + private static $generated_pdf_path = 'assets/_generated_pdfs'; |
|
| 72 | + |
|
| 73 | + private static $api_access = [ |
|
| 74 | + 'view' => [ |
|
| 75 | + 'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription', |
|
| 76 | + 'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID' |
|
| 77 | + ], |
|
| 78 | + 'edit' => [ |
|
| 79 | + 'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription', |
|
| 80 | + 'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID' |
|
| 81 | + ], |
|
| 82 | + ]; |
|
| 83 | + |
|
| 84 | + private static $table_name = 'BasePage'; |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * @config |
|
| 88 | + * @var string |
|
| 89 | + */ |
|
| 90 | + private static $related_pages_title = 'Related pages'; |
|
| 91 | + |
|
| 92 | + private static $many_many = [ |
|
| 93 | + 'Terms' => TaxonomyTerm::class, |
|
| 94 | + 'RelatedPages' => BasePage::class, |
|
| 95 | + ]; |
|
| 96 | + |
|
| 97 | + private static $many_many_extraFields = [ |
|
| 98 | + 'RelatedPages' => [ |
|
| 99 | + 'SortOrder' => 'Int', |
|
| 100 | + ], |
|
| 101 | + ]; |
|
| 102 | + |
|
| 103 | + private static $plural_name = 'Base Pages'; |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * Get the footer holder. |
|
| 107 | + */ |
|
| 108 | + public function getFooter() |
|
| 109 | + { |
|
| 110 | + return FooterHolder::get_one(FooterHolder::class); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Return the full filename of the pdf file, including path & extension |
|
| 115 | + */ |
|
| 116 | + public function getPdfFilename() |
|
| 117 | + { |
|
| 118 | + $baseName = sprintf('%s-%s', $this->URLSegment, $this->ID); |
|
| 119 | + |
|
| 120 | + $folderPath = $this->config()->get('generated_pdf_path'); |
|
| 121 | + if ($folderPath[0] != '/') { |
|
| 122 | + $folderPath = BASE_PATH . '/' . $folderPath; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + return sprintf('%s/%s.pdf', $folderPath, $baseName); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * Build pdf link for template. |
|
| 130 | + */ |
|
| 131 | + public function PdfLink() |
|
| 132 | + { |
|
| 133 | + if (!$this->config()->get('pdf_export')) { |
|
| 134 | + return false; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + $path = $this->getPdfFilename(); |
|
| 138 | + |
|
| 139 | + if ((Versioned::get_stage() === Versioned::LIVE) && file_exists($path)) { |
|
| 140 | + return Director::baseURL() . preg_replace('#^/#', '', Director::makeRelative($path)); |
|
| 141 | + } |
|
| 142 | + return $this->Link('downloadpdf'); |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + public function RelatedPages() |
|
| 146 | + { |
|
| 147 | + return $this->getManyManyComponents('RelatedPages')->sort('SortOrder'); |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + public function RelatedPagesTitle() |
|
| 151 | + { |
|
| 152 | + return $this->config()->get('related_pages_title'); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Remove linked pdf when publishing the page, |
|
| 157 | + * as it would be out of date. |
|
| 158 | + */ |
|
| 159 | + public function onAfterPublish() |
|
| 160 | + { |
|
| 161 | + $filepath = $this->getPdfFilename(); |
|
| 162 | + if (file_exists($filepath)) { |
|
| 163 | + unlink($filepath); |
|
| 164 | + } |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * Remove linked pdf when unpublishing the page, |
|
| 169 | + * so it's no longer valid. |
|
| 170 | + * |
|
| 171 | + * @return boolean |
|
| 172 | + */ |
|
| 173 | + public function doUnpublish() |
|
| 174 | + { |
|
| 175 | + if (!parent::doUnpublish()) { |
|
| 176 | + return false; |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + $filepath = $this->getPdfFilename(); |
|
| 180 | + if (file_exists($filepath)) { |
|
| 181 | + unlink($filepath); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + return true; |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + public function getCMSFields() |
|
| 188 | + { |
|
| 189 | + $this->beforeUpdateCMSFields(function (FieldList $fields) { |
|
| 190 | + // Related Pages |
|
| 191 | + $components = GridFieldConfig_RelationEditor::create(); |
|
| 192 | + $components->removeComponentsByType(GridFieldAddNewButton::class); |
|
| 193 | + $components->removeComponentsByType(GridFieldEditButton::class); |
|
| 194 | + $components->removeComponentsByType(GridFieldFilterHeader::class); |
|
| 195 | + $components->addComponent(new GridFieldSortableRows('SortOrder')); |
|
| 196 | + |
|
| 197 | + /** @var GridFieldDataColumns $dataColumns */ |
|
| 198 | + $dataColumns = $components->getComponentByType(GridFieldDataColumns::class); |
|
| 199 | + $dataColumns->setDisplayFields([ |
|
| 200 | + 'Title' => _t(__CLASS__ . '.ColumnTitle', 'Title'), |
|
| 201 | + 'ClassName' => _t(__CLASS__ . '.ColumnPageType', 'Page Type') |
|
| 202 | + ]); |
|
| 203 | + |
|
| 204 | + $fields->findOrMakeTab( |
|
| 205 | + 'Root.RelatedPages', |
|
| 206 | + _t(__CLASS__ . '.RelatedPages', 'Related pages') |
|
| 207 | + ); |
|
| 208 | + $fields->addFieldToTab( |
|
| 209 | + 'Root.RelatedPages', |
|
| 210 | + GridField::create( |
|
| 211 | + 'RelatedPages', |
|
| 212 | + _t(__CLASS__ . '.RelatedPages', 'Related pages'), |
|
| 213 | + $this->RelatedPages(), |
|
| 214 | + $components |
|
| 215 | + ) |
|
| 216 | + ); |
|
| 217 | + |
|
| 218 | + // Taxonomies - Unless they have their own 'Tags' field (such as in Blog, etc) |
|
| 219 | + $hasMany = $this->hasMany(); |
|
| 220 | + $manyMany = $this->manyMany(); |
|
| 221 | + if (!isset($hasMany['Tags']) && !isset($manyMany['Tags'])) { |
|
| 222 | + $components = GridFieldConfig_RelationEditor::create(); |
|
| 223 | + $components->removeComponentsByType(GridFieldAddNewButton::class); |
|
| 224 | + $components->removeComponentsByType(GridFieldEditButton::class); |
|
| 225 | + |
|
| 226 | + /** @var GridFieldAddExistingAutocompleter $autoCompleter */ |
|
| 227 | + $autoCompleter = $components->getComponentByType(GridFieldAddExistingAutocompleter::class); |
|
| 228 | + $autoCompleter->setResultsFormat('$Name ($TaxonomyName)'); |
|
| 229 | + |
|
| 230 | + /** @var GridFieldDataColumns $dataColumns */ |
|
| 231 | + $dataColumns = $components->getComponentByType(GridFieldDataColumns::class); |
|
| 232 | + $dataColumns->setDisplayFields([ |
|
| 233 | + 'Name' => _t(__CLASS__ . '.Term', 'Term'), |
|
| 234 | + 'TaxonomyName' => _t(__CLASS__ . '.Taxonomy', 'Taxonomy') |
|
| 235 | + ]); |
|
| 236 | + |
|
| 237 | + $fields->findOrMakeTab('Root.Tags', _t(__CLASS__ . '.TagsTabTitle', 'Tags')); |
|
| 238 | + $fields->addFieldToTab( |
|
| 239 | + 'Root.Tags', |
|
| 240 | + TreeMultiselectField::create( |
|
| 241 | + 'Terms', |
|
| 242 | + _t(__CLASS__ . '.Terms', 'Terms'), |
|
| 243 | + TaxonomyTerm::class |
|
| 244 | + )->setDescription(_t(__CLASS__ . '.TermsDescription', 'Click to search for additional terms')) |
|
| 245 | + ); |
|
| 246 | + } |
|
| 247 | + }); |
|
| 248 | + return parent::getCMSFields(); |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * Returns the native language name for the selected locale/language, empty string if Fluent is not available |
|
| 253 | + * |
|
| 254 | + * @return string |
|
| 255 | + */ |
|
| 256 | + public function getSelectedLanguage() |
|
| 257 | + { |
|
| 258 | + if (!class_exists(Locale::class) || !$this->hasMethod('Locales')) { |
|
| 259 | + return ''; |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + /** @var ArrayData $information */ |
|
| 263 | + $information = $this->LocaleInformation(FluentState::singleton()->getLocale()); |
|
| 264 | + |
|
| 265 | + return $information->LanguageNative; |
|
| 266 | + } |
|
| 267 | 267 | } |
@@ -13,163 +13,163 @@ |
||
| 13 | 13 | |
| 14 | 14 | class BasePageController extends ContentController |
| 15 | 15 | { |
| 16 | - private static $allowed_actions = [ |
|
| 17 | - 'downloadpdf', |
|
| 18 | - ]; |
|
| 19 | - |
|
| 20 | - /** |
|
| 21 | - * Serve the page rendered as PDF. |
|
| 22 | - */ |
|
| 23 | - public function downloadpdf() |
|
| 24 | - { |
|
| 25 | - if (!Config::inst()->get(BasePage::class, 'pdf_export')) { |
|
| 26 | - return false; |
|
| 27 | - } |
|
| 28 | - |
|
| 29 | - // We only allow producing live pdf. There is no way to secure the draft files. |
|
| 30 | - Versioned::set_stage(Versioned::LIVE); |
|
| 31 | - |
|
| 32 | - $path = $this->dataRecord->getPdfFilename(); |
|
| 33 | - if (!file_exists($path)) { |
|
| 34 | - $this->generatePDF(); |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - return HTTPRequest::send_file(file_get_contents($path), basename($path), 'application/pdf'); |
|
| 38 | - } |
|
| 39 | - |
|
| 40 | - /* |
|
| 16 | + private static $allowed_actions = [ |
|
| 17 | + 'downloadpdf', |
|
| 18 | + ]; |
|
| 19 | + |
|
| 20 | + /** |
|
| 21 | + * Serve the page rendered as PDF. |
|
| 22 | + */ |
|
| 23 | + public function downloadpdf() |
|
| 24 | + { |
|
| 25 | + if (!Config::inst()->get(BasePage::class, 'pdf_export')) { |
|
| 26 | + return false; |
|
| 27 | + } |
|
| 28 | + |
|
| 29 | + // We only allow producing live pdf. There is no way to secure the draft files. |
|
| 30 | + Versioned::set_stage(Versioned::LIVE); |
|
| 31 | + |
|
| 32 | + $path = $this->dataRecord->getPdfFilename(); |
|
| 33 | + if (!file_exists($path)) { |
|
| 34 | + $this->generatePDF(); |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + return HTTPRequest::send_file(file_get_contents($path), basename($path), 'application/pdf'); |
|
| 38 | + } |
|
| 39 | + |
|
| 40 | + /* |
|
| 41 | 41 | * This will return either pdf_base_url from YML, CWP_SECURE_DOMAIN |
| 42 | 42 | * from _ss_environment, or blank. In that order of importance. |
| 43 | 43 | */ |
| 44 | - public function getPDFBaseURL() |
|
| 45 | - { |
|
| 46 | - //if base url YML is defined in YML, use that |
|
| 47 | - if (Config::inst()->get(BasePage::class, 'pdf_base_url')) { |
|
| 48 | - $pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/'; |
|
| 49 | - //otherwise, if we are CWP use the secure domain |
|
| 50 | - } elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) { |
|
| 51 | - $pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/'; |
|
| 52 | - //or if neither, leave blank |
|
| 53 | - } else { |
|
| 54 | - $pdfBaseUrl = ''; |
|
| 55 | - } |
|
| 56 | - return $pdfBaseUrl; |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - /* |
|
| 44 | + public function getPDFBaseURL() |
|
| 45 | + { |
|
| 46 | + //if base url YML is defined in YML, use that |
|
| 47 | + if (Config::inst()->get(BasePage::class, 'pdf_base_url')) { |
|
| 48 | + $pdfBaseUrl = Config::inst()->get(BasePage::class, 'pdf_base_url').'/'; |
|
| 49 | + //otherwise, if we are CWP use the secure domain |
|
| 50 | + } elseif (Environment::getEnv('CWP_SECURE_DOMAIN')) { |
|
| 51 | + $pdfBaseUrl = Environment::getEnv('CWP_SECURE_DOMAIN') . '/'; |
|
| 52 | + //or if neither, leave blank |
|
| 53 | + } else { |
|
| 54 | + $pdfBaseUrl = ''; |
|
| 55 | + } |
|
| 56 | + return $pdfBaseUrl; |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + /* |
|
| 60 | 60 | * Don't use the proxy if the pdf domain is the CWP secure domain |
| 61 | 61 | * Or if we aren't on a CWP server |
| 62 | 62 | */ |
| 63 | - public function getPDFProxy($pdfBaseUrl) |
|
| 64 | - { |
|
| 65 | - if (!Environment::getEnv('CWP_SECURE_DOMAIN') |
|
| 66 | - || $pdfBaseUrl == Environment::getEnv('CWP_SECURE_DOMAIN') . '/' |
|
| 67 | - ) { |
|
| 68 | - $proxy = ''; |
|
| 69 | - } else { |
|
| 70 | - $proxy = ' --proxy ' . Environment::getEnv('SS_OUTBOUND_PROXY') |
|
| 71 | - . ':' . Environment::getEnv('SS_OUTBOUND_PROXY_PORT'); |
|
| 72 | - } |
|
| 73 | - return $proxy; |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Render the page as PDF using wkhtmltopdf. |
|
| 78 | - */ |
|
| 79 | - public function generatePDF() |
|
| 80 | - { |
|
| 81 | - if (!Config::inst()->get(BasePage::class, 'pdf_export')) { |
|
| 82 | - return false; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - $binaryPath = Config::inst()->get(BasePage::class, 'wkhtmltopdf_binary'); |
|
| 86 | - if (!$binaryPath || !is_executable($binaryPath)) { |
|
| 87 | - if (Environment::getEnv('WKHTMLTOPDF_BINARY') |
|
| 88 | - && is_executable(Environment::getEnv('WKHTMLTOPDF_BINARY')) |
|
| 89 | - ) { |
|
| 90 | - $binaryPath = Environment::getEnv('WKHTMLTOPDF_BINARY'); |
|
| 91 | - } |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - if (!$binaryPath) { |
|
| 95 | - user_error('Neither WKHTMLTOPDF_BINARY nor BasePage.wkhtmltopdf_binary are defined', E_USER_ERROR); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - if (Versioned::get_reading_mode() == 'Stage.Stage') { |
|
| 99 | - user_error('Generating PDFs on draft is not supported', E_USER_ERROR); |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - set_time_limit(60); |
|
| 103 | - |
|
| 104 | - // prepare the paths |
|
| 105 | - $pdfFile = $this->dataRecord->getPdfFilename(); |
|
| 106 | - $bodyFile = str_replace('.pdf', '_pdf.html', $pdfFile); |
|
| 107 | - $footerFile = str_replace('.pdf', '_pdffooter.html', $pdfFile); |
|
| 108 | - |
|
| 109 | - // make sure the work directory exists |
|
| 110 | - if (!file_exists(dirname($pdfFile))) { |
|
| 111 | - Filesystem::makeFolder(dirname($pdfFile)); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - //decide the domain to use in generation |
|
| 115 | - $pdfBaseUrl = $this->getPDFBaseURL(); |
|
| 116 | - |
|
| 117 | - // Force http protocol on CWP - fetching from localhost without using the proxy, SSL terminates on gateway. |
|
| 118 | - if (Environment::getEnv('CWP_ENVIRONMENT')) { |
|
| 119 | - Config::modify()->set(Director::class, 'alternate_protocol', 'http'); |
|
| 120 | - //only set alternate protocol if CWP_SECURE_DOMAIN is defined OR pdf_base_url is |
|
| 121 | - if ($pdfBaseUrl) { |
|
| 122 | - Config::modify()->set(Director::class, 'alternate_base_url', 'http://' . $pdfBaseUrl); |
|
| 123 | - } |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - $bodyViewer = $this->getViewer('pdf'); |
|
| 127 | - |
|
| 128 | - // write the output of this page to HTML, ready for conversion to PDF |
|
| 129 | - file_put_contents($bodyFile, $bodyViewer->process($this)); |
|
| 130 | - |
|
| 131 | - // get the viewer for the current template with _pdffooter |
|
| 132 | - $footerViewer = $this->getViewer('pdffooter'); |
|
| 133 | - |
|
| 134 | - // write the output of the footer template to HTML, ready for conversion to PDF |
|
| 135 | - file_put_contents($footerFile, $footerViewer->process($this)); |
|
| 136 | - |
|
| 137 | - //decide what the proxy should look like |
|
| 138 | - $proxy = $this->getPDFProxy($pdfBaseUrl); |
|
| 139 | - |
|
| 140 | - // finally, generate the PDF |
|
| 141 | - $command = $binaryPath . $proxy . ' --outline -B 40pt -L 20pt -R 20pt -T 20pt --encoding utf-8 ' |
|
| 142 | - . '--orientation Portrait --disable-javascript --quiet --print-media-type '; |
|
| 143 | - $retVal = 0; |
|
| 144 | - $output = array(); |
|
| 145 | - exec( |
|
| 146 | - $command . " --footer-html \"$footerFile\" \"$bodyFile\" \"$pdfFile\" &> /dev/stdout", |
|
| 147 | - $output, |
|
| 148 | - $retVal |
|
| 149 | - ); |
|
| 150 | - |
|
| 151 | - // remove temporary file |
|
| 152 | - unlink($bodyFile); |
|
| 153 | - unlink($footerFile); |
|
| 154 | - |
|
| 155 | - // output any errors |
|
| 156 | - if ($retVal != 0) { |
|
| 157 | - user_error('wkhtmltopdf failed: ' . implode("\n", $output), E_USER_ERROR); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - // serve the generated file |
|
| 161 | - return HTTPRequest::send_file(file_get_contents($pdfFile), basename($pdfFile), 'application/pdf'); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Provide current year. |
|
| 166 | - */ |
|
| 167 | - public function CurrentDatetime() |
|
| 168 | - { |
|
| 169 | - return DBDatetime::now(); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - public function getRSSLink() |
|
| 173 | - { |
|
| 174 | - } |
|
| 63 | + public function getPDFProxy($pdfBaseUrl) |
|
| 64 | + { |
|
| 65 | + if (!Environment::getEnv('CWP_SECURE_DOMAIN') |
|
| 66 | + || $pdfBaseUrl == Environment::getEnv('CWP_SECURE_DOMAIN') . '/' |
|
| 67 | + ) { |
|
| 68 | + $proxy = ''; |
|
| 69 | + } else { |
|
| 70 | + $proxy = ' --proxy ' . Environment::getEnv('SS_OUTBOUND_PROXY') |
|
| 71 | + . ':' . Environment::getEnv('SS_OUTBOUND_PROXY_PORT'); |
|
| 72 | + } |
|
| 73 | + return $proxy; |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Render the page as PDF using wkhtmltopdf. |
|
| 78 | + */ |
|
| 79 | + public function generatePDF() |
|
| 80 | + { |
|
| 81 | + if (!Config::inst()->get(BasePage::class, 'pdf_export')) { |
|
| 82 | + return false; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + $binaryPath = Config::inst()->get(BasePage::class, 'wkhtmltopdf_binary'); |
|
| 86 | + if (!$binaryPath || !is_executable($binaryPath)) { |
|
| 87 | + if (Environment::getEnv('WKHTMLTOPDF_BINARY') |
|
| 88 | + && is_executable(Environment::getEnv('WKHTMLTOPDF_BINARY')) |
|
| 89 | + ) { |
|
| 90 | + $binaryPath = Environment::getEnv('WKHTMLTOPDF_BINARY'); |
|
| 91 | + } |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + if (!$binaryPath) { |
|
| 95 | + user_error('Neither WKHTMLTOPDF_BINARY nor BasePage.wkhtmltopdf_binary are defined', E_USER_ERROR); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + if (Versioned::get_reading_mode() == 'Stage.Stage') { |
|
| 99 | + user_error('Generating PDFs on draft is not supported', E_USER_ERROR); |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + set_time_limit(60); |
|
| 103 | + |
|
| 104 | + // prepare the paths |
|
| 105 | + $pdfFile = $this->dataRecord->getPdfFilename(); |
|
| 106 | + $bodyFile = str_replace('.pdf', '_pdf.html', $pdfFile); |
|
| 107 | + $footerFile = str_replace('.pdf', '_pdffooter.html', $pdfFile); |
|
| 108 | + |
|
| 109 | + // make sure the work directory exists |
|
| 110 | + if (!file_exists(dirname($pdfFile))) { |
|
| 111 | + Filesystem::makeFolder(dirname($pdfFile)); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + //decide the domain to use in generation |
|
| 115 | + $pdfBaseUrl = $this->getPDFBaseURL(); |
|
| 116 | + |
|
| 117 | + // Force http protocol on CWP - fetching from localhost without using the proxy, SSL terminates on gateway. |
|
| 118 | + if (Environment::getEnv('CWP_ENVIRONMENT')) { |
|
| 119 | + Config::modify()->set(Director::class, 'alternate_protocol', 'http'); |
|
| 120 | + //only set alternate protocol if CWP_SECURE_DOMAIN is defined OR pdf_base_url is |
|
| 121 | + if ($pdfBaseUrl) { |
|
| 122 | + Config::modify()->set(Director::class, 'alternate_base_url', 'http://' . $pdfBaseUrl); |
|
| 123 | + } |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + $bodyViewer = $this->getViewer('pdf'); |
|
| 127 | + |
|
| 128 | + // write the output of this page to HTML, ready for conversion to PDF |
|
| 129 | + file_put_contents($bodyFile, $bodyViewer->process($this)); |
|
| 130 | + |
|
| 131 | + // get the viewer for the current template with _pdffooter |
|
| 132 | + $footerViewer = $this->getViewer('pdffooter'); |
|
| 133 | + |
|
| 134 | + // write the output of the footer template to HTML, ready for conversion to PDF |
|
| 135 | + file_put_contents($footerFile, $footerViewer->process($this)); |
|
| 136 | + |
|
| 137 | + //decide what the proxy should look like |
|
| 138 | + $proxy = $this->getPDFProxy($pdfBaseUrl); |
|
| 139 | + |
|
| 140 | + // finally, generate the PDF |
|
| 141 | + $command = $binaryPath . $proxy . ' --outline -B 40pt -L 20pt -R 20pt -T 20pt --encoding utf-8 ' |
|
| 142 | + . '--orientation Portrait --disable-javascript --quiet --print-media-type '; |
|
| 143 | + $retVal = 0; |
|
| 144 | + $output = array(); |
|
| 145 | + exec( |
|
| 146 | + $command . " --footer-html \"$footerFile\" \"$bodyFile\" \"$pdfFile\" &> /dev/stdout", |
|
| 147 | + $output, |
|
| 148 | + $retVal |
|
| 149 | + ); |
|
| 150 | + |
|
| 151 | + // remove temporary file |
|
| 152 | + unlink($bodyFile); |
|
| 153 | + unlink($footerFile); |
|
| 154 | + |
|
| 155 | + // output any errors |
|
| 156 | + if ($retVal != 0) { |
|
| 157 | + user_error('wkhtmltopdf failed: ' . implode("\n", $output), E_USER_ERROR); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + // serve the generated file |
|
| 161 | + return HTTPRequest::send_file(file_get_contents($pdfFile), basename($pdfFile), 'application/pdf'); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Provide current year. |
|
| 166 | + */ |
|
| 167 | + public function CurrentDatetime() |
|
| 168 | + { |
|
| 169 | + return DBDatetime::now(); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + public function getRSSLink() |
|
| 173 | + { |
|
| 174 | + } |
|
| 175 | 175 | } |
@@ -9,35 +9,35 @@ |
||
| 9 | 9 | |
| 10 | 10 | class DatedUpdateHolderControllerTest extends FunctionalTest |
| 11 | 11 | { |
| 12 | - protected static $fixture_file = 'EventHolderTest.yml'; |
|
| 12 | + protected static $fixture_file = 'EventHolderTest.yml'; |
|
| 13 | 13 | |
| 14 | - protected static $use_draft_site = true; |
|
| 14 | + protected static $use_draft_site = true; |
|
| 15 | 15 | |
| 16 | - protected function setUp() |
|
| 17 | - { |
|
| 18 | - parent::setUp(); |
|
| 16 | + protected function setUp() |
|
| 17 | + { |
|
| 18 | + parent::setUp(); |
|
| 19 | 19 | |
| 20 | - // Note: this test requires the starter theme to be installed |
|
| 21 | - Config::inst()->update(SSViewer::class, 'theme', 'starter'); |
|
| 22 | - } |
|
| 20 | + // Note: this test requires the starter theme to be installed |
|
| 21 | + Config::inst()->update(SSViewer::class, 'theme', 'starter'); |
|
| 22 | + } |
|
| 23 | 23 | |
| 24 | - public function testSettingDateFiltersInReverseOrderShowsMessage() |
|
| 25 | - { |
|
| 26 | - /** @var EventHolder $holder */ |
|
| 27 | - $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 24 | + public function testSettingDateFiltersInReverseOrderShowsMessage() |
|
| 25 | + { |
|
| 26 | + /** @var EventHolder $holder */ |
|
| 27 | + $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 28 | 28 | |
| 29 | - $result = $this->get($holder->Link() . '?from=2018-01-10&to=2018-01-01'); |
|
| 29 | + $result = $this->get($holder->Link() . '?from=2018-01-10&to=2018-01-01'); |
|
| 30 | 30 | |
| 31 | - $this->assertContains('Filter has been applied with the dates reversed', $result->getBody()); |
|
| 32 | - } |
|
| 31 | + $this->assertContains('Filter has been applied with the dates reversed', $result->getBody()); |
|
| 32 | + } |
|
| 33 | 33 | |
| 34 | - public function testSettingFromButNotToDateShowsMessage() |
|
| 35 | - { |
|
| 36 | - /** @var EventHolder $holder */ |
|
| 37 | - $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 34 | + public function testSettingFromButNotToDateShowsMessage() |
|
| 35 | + { |
|
| 36 | + /** @var EventHolder $holder */ |
|
| 37 | + $holder = $this->objFromFixture(EventHolder::class, 'EventHolder1'); |
|
| 38 | 38 | |
| 39 | - $result = $this->get($holder->Link() . '?from=2018-01-10'); |
|
| 39 | + $result = $this->get($holder->Link() . '?from=2018-01-10'); |
|
| 40 | 40 | |
| 41 | - $this->assertContains('Filtered by a single date', $result->getBody()); |
|
| 42 | - } |
|
| 41 | + $this->assertContains('Filtered by a single date', $result->getBody()); |
|
| 42 | + } |
|
| 43 | 43 | } |