FEATURE: Exposing a way to add a generic report filter

app/assets/javascripts/admin/components/admin-report-table.js.es6

@@ -79,8 +79,8 @@ export default Ember.Component.extend({
     if (sortLabel) {
       const compare = (label, direction) => {
         return (a, b) => {
-          let aValue = label.compute(a).value;
-          let bValue = label.compute(b).value;
+          const aValue = label.compute(a, { useSortProperty: true }).value;
+          const bValue = label.compute(b, { useSortProperty: true }).value;
           const result = aValue < bValue ? -1 : aValue > bValue ? 1 : 0;
           return result * direction;
         };

app/assets/javascripts/admin/components/admin-report.js.es6

@@ -56,6 +56,7 @@ export default Ember.Component.extend({
   endDate: null,
   category: null,
   groupId: null,
+  filter: null,
   showTrend: false,
   showHeader: true,
   showTitle: true,
@@ -85,6 +86,7 @@ export default Ember.Component.extend({
     this.setProperties({
       category: Category.findById(state.categoryId),
       groupId: state.groupId,
+      filter: state.filter,
       startDate: state.startDate,
       endDate: state.endDate
     });
@@ -174,6 +176,18 @@ export default Ember.Component.extend({
     return `admin-report-${currentMode}`;
   },
 
+  @computed("model.filter_options")
+  filterOptions(options) {
+    if (options) {
+      return options.map(option => {
+        if (option.allowAny) {
+          option.choices.unshift(I18n.t("admin.dashboard.report_filter_any"));
+        }
+        return option;
+      });
+    }
+  },
+
   @computed("startDate")
   normalizedStartDate(startDate) {
     return startDate && typeof startDate.isValid === "function"
@@ -202,10 +216,11 @@ export default Ember.Component.extend({
     "dataSourceName",
     "categoryId",
     "groupId",
+    "filter",
     "normalizedStartDate",
     "normalizedEndDate"
   )
-  reportKey(dataSourceName, categoryId, groupId, startDate, endDate) {
+  reportKey(dataSourceName, categoryId, groupId, filter, startDate, endDate) {
     if (!dataSourceName || !startDate || !endDate) return null;
 
     let reportKey = "reports:";
@@ -215,6 +230,7 @@ export default Ember.Component.extend({
       startDate.replace(/-/g, ""),
       endDate.replace(/-/g, ""),
       groupId,
+      filter,
       "[:prev_period]",
       this.get("reportOptions.table.limit"),
       SCHEMA_VERSION
@@ -227,10 +243,35 @@ export default Ember.Component.extend({
   },
 
   actions: {
+    filter(filterOptionId, value) {
+      let params = [];
+      let paramPairs = {};
+      let newParams = [];
+
+      if (this.get("filter")) {
+        const filter = this.get("filter").slice(1, -1);
+        params = filter.split("&") || [];
+        params.map(p => {
+          const pair = p.split("=");
+          paramPairs[pair[0]] = pair[1];
+        });
+      }
+
+      paramPairs[filterOptionId] = value;
+      Object.keys(paramPairs).forEach(key => {
+        if (paramPairs[key] !== I18n.t("admin.dashboard.report_filter_any")) {
+          newParams.push(`${key}=${paramPairs[key]}`);
+        }
+      });
+
+      this.set("filter", `[${newParams.join("&")}]`);
+    },
+
     refreshReport() {
       this.attrs.onRefresh({
         categoryId: this.get("categoryId"),
         groupId: this.get("groupId"),
+        filter: this.get("filter"),
         startDate: this.get("startDate"),
         endDate: this.get("endDate")
       });
@@ -366,6 +407,10 @@ export default Ember.Component.extend({
       payload.data.category_id = this.get("categoryId");
     }
 
+    if (this.get("filter") && this.get("filter") !== "all") {
+      payload.data.filter = this.get("filter");
+    }
+
     if (this.get("reportOptions.table.limit")) {
       payload.data.limit = this.get("reportOptions.table.limit");
     }

app/assets/javascripts/admin/controllers/admin-reports-show.js.es6

@@ -1,7 +1,7 @@
 import computed from "ember-addons/ember-computed-decorators";
 
 export default Ember.Controller.extend({
-  queryParams: ["start_date", "end_date", "category_id", "group_id"],
+  queryParams: ["start_date", "end_date", "category_id", "group_id", "filter"],
 
   @computed("model.type")
   reportOptions(type) {
@@ -14,11 +14,12 @@ export default Ember.Controller.extend({
     return options;
   },
 
-  @computed("category_id", "group_id", "start_date", "end_date")
-  filters(categoryId, groupId, startDate, endDate) {
+  @computed("category_id", "group_id", "start_date", "end_date", "filter")
+  filters(categoryId, groupId, startDate, endDate, filter) {
     return {
       categoryId,
       groupId,
+      filter,
       startDate,
       endDate
     };
@@ -28,6 +29,7 @@ export default Ember.Controller.extend({
     onParamsChange(params) {
       this.setProperties({
         start_date: params.startDate,
+        filter: params.filter,
         category_id: params.categoryId,
         group_id: params.groupId,
         end_date: params.endDate

app/assets/javascripts/admin/models/report.js.es6

@@ -264,7 +264,13 @@ const Report = Discourse.Model.extend({
         mainProperty,
         type,
         compute: (row, opts = {}) => {
-          const value = row[mainProperty];
+          let value = null;
+
+          if (opts.useSortProperty) {
+            value = row[label.sort_property || mainProperty];
+          } else {
+            value = row[mainProperty];
+          }
 
           if (type === "user") return this._userLabel(label.properties, row);
           if (type === "post") return this._postLabel(label.properties, row);

app/assets/javascripts/admin/templates/components/admin-report.hbs

@@ -173,6 +173,18 @@
           </div>
         {{/if}}
 
+        {{#each filterOptions as |filterOption|}}
+          <div class="control">
+            <div class="input">
+              {{combo-box content=filterOption.choices
+                          filterable=true
+                          allowAny=true
+                          value=filterOption.selected
+                          onSelect=(action "filter" filterOption.id)}}
+            </div>
+          </div>
+        {{/each}}
+
         {{#if showExport}}
           <div class="control">
             <div class="input">

app/controllers/admin/reports_controller.rb

@@ -113,11 +113,17 @@ def parse_params(report_params)
       limit = report_params[:limit].to_i
     end
 
+    filter = nil
+    if report_params.has_key?(:filter)
+      filter = report_params[:filter]
+    end
+
     {
       start_date: start_date,
       end_date: end_date,
       category_id: category_id,
       group_id: group_id,
+      filter: filter,
       facets: facets,
       limit: limit
     }

app/models/report.rb

@@ -6,11 +6,11 @@ class Report
   SCHEMA_VERSION = 3
 
   attr_accessor :type, :data, :total, :prev30Days, :start_date,
-                :end_date, :category_id, :group_id, :labels, :async,
-                :prev_period, :facets, :limit, :processing, :average, :percent,
+                :end_date, :category_id, :group_id, :filter,
+                :labels, :async, :prev_period, :facets, :limit, :processing, :average, :percent,
                 :higher_is_better, :icon, :modes, :category_filtering,
                 :group_filtering, :prev_data, :prev_start_date, :prev_end_date,
-                :dates_filtering, :error, :primary_color, :secondary_color
+                :dates_filtering, :error, :primary_color, :secondary_color, :filter_options
 
   def self.default_days
     30
@@ -29,6 +29,8 @@ def initialize(type)
     @modes = [:table, :chart]
     @prev_data = nil
     @dates_filtering = true
+    @filter_options = nil
+    @filter = nil
 
     tertiary = ColorScheme.hex_for_name('tertiary') || '0088cc'
     @primary_color = rgba_color(tertiary)
@@ -43,6 +45,7 @@ def self.cache_key(report)
       report.start_date.to_date.strftime("%Y%m%d"),
       report.end_date.to_date.strftime("%Y%m%d"),
       report.group_id,
+      report.filter,
       report.facets,
       report.limit,
       SCHEMA_VERSION,
@@ -73,9 +76,15 @@ def prev_end_date
     self.start_date
   end
 
+  def filter_values
+    if self.filter.present?
+      return self.filter.delete_prefix("[").delete_suffix("]").split("&").map { |param| param.split("=") }.to_h
+    end
+    {}
+  end
+
   def as_json(options = nil)
     description = I18n.t("reports.#{type}.description", default: "")
-
     {
       type: type,
       title: I18n.t("reports.#{type}.title", default: nil),
@@ -90,6 +99,7 @@ def as_json(options = nil)
       prev_end_date: prev_end_date&.iso8601,
       category_id: category_id,
       group_id: group_id,
+      filter: self.filter,
       prev30Days: self.prev30Days,
       dates_filtering: self.dates_filtering,
       report_key: Report.cache_key(self),
@@ -113,6 +123,7 @@ def as_json(options = nil)
       higher_is_better: self.higher_is_better,
       category_filtering: self.category_filtering,
       group_filtering: self.group_filtering,
+      filter_options: self.filter_options,
       modes: self.modes,
     }.tap do |json|
       json[:icon] = self.icon if self.icon
@@ -141,6 +152,7 @@ def self._get(type, opts = nil)
     report.end_date = opts[:end_date] if opts[:end_date]
     report.category_id = opts[:category_id] if opts[:category_id]
     report.group_id = opts[:group_id] if opts[:group_id]
+    report.filter = opts[:filter] if opts[:filter]
     report.facets = opts[:facets] || [:total, :prev30Days]
     report.limit = opts[:limit] if opts[:limit]
     report.processing = false
@@ -1484,7 +1496,14 @@ def self.report_storage_stats(report)
 
   def self.report_top_uploads(report)
     report.modes = [:table]
-
+    report.filter_options = [
+      {
+        id: "file-extension",
+        selected: report.filter_values.fetch("file-extension", "any"),
+        choices: (SiteSetting.authorized_extensions.split("|") + report.filter_values.values).uniq,
+        allowAny: true
+      }
+    ]
     report.labels = [
       {
         type: :link,
@@ -1529,14 +1548,18 @@ def self.report_top_uploads(report)
     FROM uploads up
     JOIN users u
     ON u.id = up.user_id
-    WHERE up.created_at >= '#{report.start_date}'
-    AND up.created_at <= '#{report.end_date}'
-    AND up.id > #{Upload::SEEDED_ID_THRESHOLD}
+    /*where*/
     ORDER BY up.filesize DESC
     LIMIT #{report.limit || 250}
     SQL
 
-    DB.query(sql).each do |row|
+    extension_filter = report.filter_values["file-extension"]
+    builder = DB.build(sql)
+    builder.where("up.id > :seeded_id_threshold", seeded_id_threshold: Upload::SEEDED_ID_THRESHOLD)
+    builder.where("up.created_at >= :start_date", start_date: report.start_date)
+    builder.where("up.created_at < :end_date", end_date: report.end_date)
+    builder.where("up.extension = :extension", extension: extension_filter) if extension_filter.present?
+    builder.query.each do |row|
       data = {}
       data[:author_id] = row.user_id
       data[:author_username] = row.username
@@ -1545,7 +1568,6 @@ def self.report_top_uploads(report)
       data[:extension] = row.extension
       data[:file_url] = Discourse.store.cdn_url(row.url)
       data[:file_name] = row.original_filename.truncate(25)
-
       report.data << data
     end
   end

config/locales/client.en.yml

@@ -2949,6 +2949,7 @@ en:
         moderation_tab: "Moderation"
         security_tab: "Security"
         reports_tab: "Reports"
+        report_filter_any: "any"
         disabled: Disabled
         timeout_error: Sorry, query is taking too long, please pick a shorter interval
         exception_error: Sorry, an error occurred while executing the query