first commit

blog/classes/reportbuilder/datasource/blogs.php

@@ -0,0 +1,179 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+declare(strict_types=1);
+
+namespace core_blog\reportbuilder\datasource;
+
+use lang_string;
+use core_reportbuilder\datasource;
+use core_reportbuilder\local\entities\{course, user};
+use core_blog\reportbuilder\local\entities\blog;
+use core_files\reportbuilder\local\entities\file;
+use core_comment\reportbuilder\local\entities\comment;
+use core_tag\reportbuilder\local\entities\tag;
+
+/**
+ * Blogs datasource
+ *
+ * @package     core_blog
+ * @copyright   2022 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class blogs extends datasource {
+
+    /**
+     * Return user friendly name of the report source
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('blogs', 'core_blog');
+    }
+
+    /**
+     * Initialise report
+     */
+    protected function initialise(): void {
+        $blogentity = new blog();
+
+        $postalias = $blogentity->get_table_alias('post');
+        $this->set_main_table('post', $postalias);
+        $this->add_base_condition_simple("{$postalias}.module", 'blog');
+
+        $this->add_entity($blogentity);
+
+        // Join the files entity.
+        $fileentity = (new file())
+            ->set_entity_title(new lang_string('blogattachment', 'core_blog'));
+        $filesalias = $fileentity->get_table_alias('files');
+        $this->add_entity($fileentity
+            ->add_join("LEFT JOIN {files} {$filesalias}
+                ON {$filesalias}.contextid = " . SYSCONTEXTID . "
+               AND {$filesalias}.component = 'blog'
+               AND {$filesalias}.filearea = 'attachment'
+               AND {$filesalias}.itemid = {$postalias}.id
+               AND {$filesalias}.filename != '.'"));
+
+        // Join the tag entity.
+        $tagentity = (new tag())
+            ->set_entity_title(new lang_string('blogtags', 'core_blog'))
+            ->set_table_alias('tag', $blogentity->get_table_alias('tag'));
+        $this->add_entity($tagentity
+            ->add_joins($blogentity->get_tag_joins()));
+
+        // Join the user entity to represent the blog author.
+        $authorentity = (new user())
+            ->set_entity_title(new lang_string('author', 'core_blog'));
+        $authoralias = $authorentity->get_table_alias('user');
+        $this->add_entity($authorentity
+            ->add_join("LEFT JOIN {user} {$authoralias} ON {$authoralias}.id = {$postalias}.userid"));
+
+        // Join the course entity for course blogs.
+        $courseentity = new course();
+        $coursealias = $courseentity->get_table_alias('course');
+        $this->add_entity($courseentity
+            ->add_join("LEFT JOIN {course} {$coursealias} ON {$coursealias}.id = {$postalias}.courseid"));
+
+        // Join the comment entity.
+        $commententity = new comment();
+        $commentalias = $commententity->get_table_alias('comments');
+        $this->add_entity($commententity
+            ->add_join("LEFT JOIN {comments} {$commentalias} ON {$commentalias}.component = 'blog'
+                AND {$commentalias}.itemid = {$postalias}.id"));
+
+        // Join the user entity to represent the comment author.
+        $commenterentity = (new user())
+            ->set_entity_name('commenter')
+            ->set_entity_title(new lang_string('commenter', 'core_comment'));
+        $commenteralias = $commenterentity->get_table_alias('user');
+        $this->add_entity($commenterentity
+            ->add_joins($commententity->get_joins())
+            ->add_join("LEFT JOIN {user} {$commenteralias} ON {$commenteralias}.id = {$commentalias}.userid"));
+
+        // Add report elements from each of the entities we added to the report.
+        $this->add_all_from_entity($blogentity->get_entity_name());
+
+        // Add specific file/tag entity elements.
+        $this->add_columns_from_entity($fileentity->get_entity_name(), ['name', 'size', 'type', 'timecreated']);
+        $this->add_filters_from_entity($fileentity->get_entity_name(), ['name', 'size', 'timecreated']);
+        $this->add_conditions_from_entity($fileentity->get_entity_name(), ['name', 'size', 'timecreated']);
+
+        $this->add_columns_from_entity($tagentity->get_entity_name(), ['name', 'namewithlink']);
+        $this->add_filter($tagentity->get_filter('name'));
+        $this->add_condition($tagentity->get_condition('name'));
+
+        $this->add_all_from_entity($authorentity->get_entity_name());
+        $this->add_all_from_entity($courseentity->get_entity_name());
+
+        // Add specific comment entity elements.
+        $this->add_columns_from_entity($commententity->get_entity_name(), ['content', 'timecreated']);
+        $this->add_filter($commententity->get_filter('timecreated'));
+        $this->add_condition($commententity->get_filter('timecreated'));
+
+        $this->add_all_from_entity($commenterentity->get_entity_name());
+    }
+
+    /**
+     * Return the columns that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_columns(): array {
+        return [
+            'user:fullname',
+            'course:fullname',
+            'blog:title',
+            'blog:timecreated',
+        ];
+    }
+
+    /**
+     * Return the column sorting that will be added to the report upon creation
+     *
+     * @return int[]
+     */
+    public function get_default_column_sorting(): array {
+        return [
+            'user:fullname' => SORT_ASC,
+            'blog:timecreated' => SORT_ASC,
+        ];
+    }
+
+    /**
+     * Return the filters that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_filters(): array {
+        return [
+            'user:fullname',
+            'blog:title',
+            'blog:timecreated',
+        ];
+    }
+
+    /**
+     * Return the conditions that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_conditions(): array {
+        return [
+            'blog:publishstate',
+        ];
+    }
+}

blog/classes/reportbuilder/local/entities/blog.php

@@ -0,0 +1,339 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+declare(strict_types=1);
+
+namespace core_blog\reportbuilder\local\entities;
+
+use blog_entry_attachment;
+use context_system;
+use core_collator;
+use html_writer;
+use lang_string;
+use moodle_url;
+use stdClass;
+use core_reportbuilder\local\entities\base;
+use core_reportbuilder\local\filters\{boolean_select, date, select, text};
+use core_reportbuilder\local\helpers\format;
+use core_reportbuilder\local\report\{column, filter};
+
+/**
+ * Blog entity
+ *
+ * @package     core_blog
+ * @copyright   2022 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class blog extends base {
+
+    /**
+     * Database tables that this entity uses
+     *
+     * @return string[]
+     */
+    protected function get_default_tables(): array {
+        return [
+            'post',
+            'tag_instance',
+            'tag',
+        ];
+    }
+
+    /**
+     * The default title for this entity
+     *
+     * @return lang_string
+     */
+    protected function get_default_entity_title(): lang_string {
+        return new lang_string('blog', 'core_blog');
+    }
+
+    /**
+     * Initialise the entity
+     *
+     * @return base
+     */
+    public function initialise(): base {
+        $columns = $this->get_all_columns();
+        foreach ($columns as $column) {
+            $this->add_column($column);
+        }
+
+        // All the filters defined by the entity can also be used as conditions.
+        $filters = $this->get_all_filters();
+        foreach ($filters as $filter) {
+            $this
+                ->add_filter($filter)
+                ->add_condition($filter);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Returns list of all available columns
+     *
+     * @return column[]
+     */
+    protected function get_all_columns(): array {
+        global $DB;
+
+        $postalias = $this->get_table_alias('post');
+
+        // Title.
+        $columns[] = (new column(
+            'title',
+            new lang_string('entrytitle', 'core_blog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_fields("{$postalias}.subject")
+            ->set_is_sortable(true);
+
+        // Title with link.
+        $columns[] = (new column(
+            'titlewithlink',
+            new lang_string('entrytitlewithlink', 'core_blog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_fields("{$postalias}.subject, {$postalias}.id")
+            ->set_is_sortable(true)
+            ->add_callback(static function(?string $subject, stdClass $post): string {
+                if ($subject === null) {
+                    return '';
+                }
+                return html_writer::link(new moodle_url('/blog/index.php', ['entryid' => $post->id]), $subject);
+            });
+
+        // Body.
+        $summaryfieldsql = "{$postalias}.summary";
+        if ($DB->get_dbfamily() === 'oracle') {
+            $summaryfieldsql = $DB->sql_order_by_text($summaryfieldsql, 1024);
+        }
+
+        $columns[] = (new column(
+            'body',
+            new lang_string('entrybody', 'core_blog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_LONGTEXT)
+            ->add_field($summaryfieldsql, 'summary')
+            ->add_fields("{$postalias}.summaryformat, {$postalias}.id")
+            ->add_callback(static function(?string $summary, stdClass $post): string {
+                global $CFG;
+                require_once("{$CFG->libdir}/filelib.php");
+
+                if ($summary === null) {
+                    return '';
+                }
+
+                // All blog files are stored in system context.
+                $context = context_system::instance();
+                $summary = file_rewrite_pluginfile_urls($summary, 'pluginfile.php', $context->id, 'blog', 'post', $post->id);
+
+                return format_text($summary, $post->summaryformat, ['context' => $context->id]);
+            });
+
+        // Attachment.
+        $columns[] = (new column(
+            'attachment',
+            new lang_string('attachment', 'core_repository'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_BOOLEAN)
+            ->add_fields("{$postalias}.attachment, {$postalias}.id")
+            ->add_callback(static function(?bool $attachment, stdClass $post): string {
+                global $CFG, $PAGE;
+                require_once("{$CFG->dirroot}/blog/locallib.php");
+
+                if (!$attachment) {
+                    return '';
+                }
+
+                $renderer = $PAGE->get_renderer('core_blog');
+                $attachments = '';
+
+                // Loop over attached files, use blog renderer to generate appropriate content.
+                $files = get_file_storage()->get_area_files(context_system::instance()->id, 'blog', 'attachment', $post->id,
+                    'filename', false);
+                foreach ($files as $file) {
+                    $attachments .= $renderer->render(new blog_entry_attachment($file, $post->id));
+                }
+
+                return $attachments;
+            })
+            ->set_disabled_aggregation_all();
+
+        // Publish state.
+        $columns[] = (new column(
+            'publishstate',
+            new lang_string('published', 'core_blog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$postalias}.publishstate")
+            ->set_is_sortable(true)
+            ->add_callback(static function(?string $publishstate): string {
+                $states = [
+                    'draft' => new lang_string('publishtodraft', 'core_blog'),
+                    'site' => new lang_string('publishtosite', 'core_blog'),
+                    'public' => new lang_string('publishtoworld', 'core_blog'),
+                ];
+
+                if ($publishstate === null || !array_key_exists($publishstate, $states)) {
+                    return (string) $publishstate;
+                }
+
+                return (string) $states[$publishstate];
+            });
+
+        // Time created.
+        $columns[] = (new column(
+            'timecreated',
+            new lang_string('timecreated', 'core_reportbuilder'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TIMESTAMP)
+            ->add_fields("{$postalias}.created")
+            ->set_is_sortable(true)
+            ->add_callback([format::class, 'userdate']);
+
+        // Time modified.
+        $columns[] = (new column(
+            'timemodified',
+            new lang_string('timemodified', 'core_reportbuilder'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TIMESTAMP)
+            ->add_fields("{$postalias}.lastmodified")
+            ->set_is_sortable(true)
+            ->add_callback([format::class, 'userdate']);
+
+        return $columns;
+    }
+
+    /**
+     * Return list of all available filters
+     *
+     * @return filter[]
+     */
+    protected function get_all_filters(): array {
+        global $DB;
+
+        $postalias = $this->get_table_alias('post');
+
+        // Title.
+        $filters[] = (new filter(
+            text::class,
+            'title',
+            new lang_string('entrytitle', 'core_blog'),
+            $this->get_entity_name(),
+            "{$postalias}.subject"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Body.
+        $filters[] = (new filter(
+            text::class,
+            'body',
+            new lang_string('entrybody', 'core_blog'),
+            $this->get_entity_name(),
+            $DB->sql_cast_to_char("{$postalias}.summary")
+        ))
+            ->add_joins($this->get_joins());
+
+        // Attachment.
+        $filters[] = (new filter(
+            boolean_select::class,
+            'attachment',
+            new lang_string('attachment', 'core_repository'),
+            $this->get_entity_name(),
+            $DB->sql_cast_char2int("{$postalias}.attachment")
+        ))
+            ->add_joins($this->get_joins());
+
+        // Publish state.
+        $filters[] = (new filter(
+            select::class,
+            'publishstate',
+            new lang_string('published', 'core_blog'),
+            $this->get_entity_name(),
+            "{$postalias}.publishstate"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_options_callback(static function(): array {
+                $states = [
+                    'draft' => new lang_string('publishtodraft', 'core_blog'),
+                    'site' => new lang_string('publishtosite', 'core_blog'),
+                    'public' => new lang_string('publishtoworld', 'core_blog'),
+                ];
+
+                core_collator::asort($states);
+                return $states;
+            });
+
+        // Time created.
+        $filters[] = (new filter(
+            date::class,
+            'timecreated',
+            new lang_string('timecreated', 'core_reportbuilder'),
+            $this->get_entity_name(),
+            "{$postalias}.created"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_limited_operators([
+                date::DATE_ANY,
+                date::DATE_CURRENT,
+                date::DATE_LAST,
+                date::DATE_RANGE,
+            ]);
+
+        // Time modified.
+        $filters[] = (new filter(
+            date::class,
+            'timemodified',
+            new lang_string('timemodified', 'core_reportbuilder'),
+            $this->get_entity_name(),
+            "{$postalias}.lastmodified"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_limited_operators([
+                date::DATE_ANY,
+                date::DATE_CURRENT,
+                date::DATE_LAST,
+                date::DATE_RANGE,
+            ]);
+
+        return $filters;
+    }
+
+    /**
+     * Return joins necessary for retrieving tags
+     *
+     * @return string[]
+     */
+    public function get_tag_joins(): array {
+        return $this->get_tag_joins_for_entity('core', 'post', $this->get_table_alias('post') . '.id');
+    }
+}