decidim-cleaner 0.0.1

data/README.md

@@ -0,0 +1,59 @@
+# Decidim::Cleaner
+
+Clean outdated data in Decidim's database.
+
+## Usage
+
+This module provides tasks designed to cleanup the outdated data directly in database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-cleaner"
+```
+
+And then execute:
+
+```bash
+bundle
+bundle exec rails decidim_cleaner:install:migrations
+bundle exec rails db:migrate
+```
+
+You can then add to your 'config/sidekiq.yml' file:
+
+```yaml
+:schedule:
+  CleanAdminLogs:
+    cron: "0 9 0 * * *"
+    class: Decidim::Cleaner::CleanAdminLogsJob
+    queue: scheduled
+  CleanInactiveUsers:
+    cron: "0 9 0 * * *"
+    class: Decidim::Cleaner::CleanInactiveUsersJob
+    queue: scheduled
+```
+
+## Available tasks
+
+- [ ] **Delete inactive users**
+  - Cron task that checks for user accounts where `last_sign_in_at` is superior to environment variable `CLEANER_USER_INACTIVITY_LIMIT`. If true, deletes inactive user from the database.
+
+- [ ] **Delete old admin logs**
+  - Cron task that checks for admin logs where `created_at` is anterior to the time you configured in the back office. If true, deletes old admin logs from the database.
+
+## Contributing
+
+Contributions are welcome !
+
+We expect the contributions to follow the [Decidim's contribution guide](https://github.com/decidim/decidim/blob/develop/CONTRIBUTING.adoc).
+
+## Security
+
+Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by sending an email to __security [at] opensourcepolitics [dot] eu__ and not by creating a Github issue.
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+def install_module(path)
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_cleaner:install:migrations")
+    system("bundle exec rake db:migrate")
+  end
+end
+
+def seed_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rake db:seed")
+  end
+end
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app" do
+  ENV["RAILS_ENV"] = "test"
+  install_module("spec/decidim_dummy_app")
+end
+
+desc "Generates a development app"
+task :development_app do
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "development_app",
+      "--app_name",
+      "#{base_app_name}_development_app",
+      "--path",
+      "..",
+      "--recreate_db",
+      "--demo"
+    )
+  end
+
+  install_module("development_app")
+  seed_db("development_app")
+end

data/app/commands/decidim/cleaner/admin/update_organization_cleaner.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    module Admin
+      # A command with all the business logic for updating the current
+      # organization cleaner.
+      class UpdateOrganizationCleaner < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # organization - The Organization that will be updated.
+        # form - A form object with the params.
+        def initialize(organization, form)
+          @organization = organization
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          return broadcast(:ok, @organization) if update_organization
+
+          broadcast(:invalid)
+        end
+
+        private
+
+        attr_reader :form, :organization
+
+        def update_organization
+          @organization = Decidim.traceability.update!(
+            organization,
+            form.current_user,
+            attributes
+          )
+        end
+
+        def attributes
+          {
+            delete_admin_logs: form.delete_admin_logs,
+            delete_admin_logs_after: form.delete_admin_logs_after,
+            delete_inactive_users: form.delete_inactive_users,
+            delete_inactive_users_after: form.delete_inactive_users_after,
+            delete_inactive_users_email_after: form.delete_inactive_users_email_after
+          }
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/cleaner/admin/application_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+        def permission_class_chain
+          [::Decidim::Cleaner::Admin::Permissions] + super
+        end
+
+        def user_not_authorized_path
+          decidim.root_path
+        end
+
+        def user_has_no_permission_path
+          decidim.root_path
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/cleaner/admin/organization_cleaner_controller.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    module Admin
+      # Controller that allows managing the appearance of the organization.
+      class OrganizationCleanerController < Decidim::Admin::ApplicationController
+        include Decidim::Admin::Engine.routes.url_helpers
+        layout "decidim/admin/settings"
+
+        def edit
+          enforce_permission_to :update, :organization, organization: current_organization
+          @form = form(OrganizationCleanerForm).from_model(current_organization)
+        end
+
+        def update
+          enforce_permission_to :update, :organization, organization: current_organization
+          @form = form(OrganizationCleanerForm).from_params(params)
+
+          UpdateOrganizationCleaner.call(current_organization, @form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("organization.update.success", scope: "decidim.admin")
+
+              redirect_to Decidim::Admin::Engine.routes.url_helpers.edit_organization_cleaner_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("organization.update.error", scope: "decidim.admin")
+              render :edit
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/cleaner/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/forms/decidim/cleaner/admin/organization_cleaner_form.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    module Admin
+      # A form object used to update the current organization cleaner from the admin
+      # dashboard.
+      #
+      class OrganizationCleanerForm < Form
+        mimic :organization
+
+        attribute :delete_admin_logs, Boolean
+        attribute :delete_admin_logs_after, Integer
+
+        attribute :delete_inactive_users, Boolean
+        attribute :delete_inactive_users_after, Integer
+        attribute :delete_inactive_users_email_after, Integer
+      end
+    end
+  end
+end

data/app/helpers/decidim/cleaner/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    # Custom helpers, scoped to the cleaner engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/decidim/cleaner/clean_admin_logs_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    class CleanAdminLogsJob < ApplicationJob
+      queue_as :scheduled
+
+      def perform
+        Decidim::Organization.find_each do |organization|
+          next unless organization.delete_admin_logs?
+
+          Decidim::ActionLog.where(organization: organization).where("created_at < ?", Time.zone.now - (organization.delete_admin_logs_after || 365).days).delete_all
+        end
+      end
+    end
+  end
+end

data/app/jobs/decidim/cleaner/clean_inactive_users_job.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    class CleanInactiveUsersJob < ApplicationJob
+      queue_as :scheduled
+
+      def perform
+        Decidim::Organization.find_each do |organization|
+          next unless organization.delete_inactive_users?
+
+          send_warning(Decidim::User.where(organization: organization)
+                                    .where("last_sign_in_at < ?", Time.zone.now - (organization.delete_inactive_users_email_after || 365).days)
+                                    .where("last_sign_in_at > ?", Time.zone.now - (organization.delete_inactive_users_email_after || 365).days - 1.day))
+          delete_user_and_send_email(Decidim::User
+                                       .where(organization: organization)
+                                       .where("last_sign_in_at < ?", Time.zone.now - (organization.delete_inactive_users_after || 390).days))
+        end
+      end
+
+      def send_warning(users)
+        users.each do |user|
+          InactiveUsersMailer.warning_inactive(user).deliver_now
+          Rails.logger.info "Inactive warning sent to #{user.email}"
+        end
+      end
+
+      def delete_user_and_send_email(users)
+        users.each do |user|
+          InactiveUsersMailer.warning_deletion(user).deliver_now
+          Rails.logger.info "Deletion warning sent to #{user.email}"
+          user.delete
+          Rails.logger.info "User #{user.email} deleted"
+        end
+      end
+    end
+  end
+end

data/app/mailers/decidim/cleaner/inactive_users_mailer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    # A custom mailer for Decidim so we can notify users
+    # when their account was blocked
+    class InactiveUsersMailer < Decidim::ApplicationMailer
+      def warning_inactive(user)
+        with_user(user) do
+          @user = user
+          @organization = user.organization
+          subject = I18n.t(
+            "decidim.cleaner.inactive_users_mailer.warning_inactive.subject",
+            organization_name: @organization.name
+          )
+          mail(to: user.email, subject: subject)
+        end
+      end
+
+      def warning_deletion(user)
+        with_user(user) do
+          @user = user
+          @organization = user.organization
+          subject = I18n.t(
+            "decidim.cleaner.inactive_users_mailer.warning_deletion.subject",
+            organization_name: @organization.name
+          )
+          mail(to: user.email, subject: subject)
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/cleaner/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/packs/entrypoints/decidim_cleaner.js

@@ -0,0 +1,2 @@
+// Images
+require.context("../images", true)

data/app/packs/images/decidim/cleaner/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/app/packs/stylesheets/decidim/cleaner/cleaner.scss

@@ -0,0 +1 @@
+/* css for decidim_cleaner */

data/app/permissions/decidim/cleaner/admin/permissions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action if permission_action.scope != :admin
+          return permission_action unless user&.admin?
+
+          allow! if can_access?
+
+          permission_action
+        end
+
+        def can_access?
+          permission_action.subject == :cleaner &&
+            permission_action.action == :read
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/cleaner/admin/organization_cleaner/_form.html.erb

@@ -0,0 +1,39 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= t ".admin_log_cleaner_title" %></h2>
+  </div>
+  <div class="card-section">
+    <div class="row">
+      <div class="columns xlarge-6 slug">
+        <%= form.check_box :delete_admin_logs %>
+      </div>
+
+      <div class="columns xlarge-6">
+        <%= form.number_field :delete_admin_logs_after %>
+      </div>
+    </div>
+  </div>
+</div>
+
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= t ".inactive_users_cleaner_title" %></h2>
+  </div>
+  <div class="card-section">
+    <div class="row">
+      <div class="columns xlarge-6 slug">
+        <%= form.check_box :delete_inactive_users %>
+      </div>
+
+      <div class="columns xlarge-6">
+        <%= form.number_field :delete_inactive_users_email_after %>
+      </div>
+
+      <div class="columns xlarge-6">
+        <%= form.number_field :delete_inactive_users_after %>
+      </div>
+    </div>
+  </div>
+</div>
+
+

data/app/views/decidim/cleaner/admin/organization_cleaner/edit.html.erb

@@ -0,0 +1,6 @@
+<%= decidim_form_for(@form, html: { class: "form edit_organization_cleaner" }, url:"/admin/organization/cleaner" , method: :put) do |f| %>
+  <%= render partial: "form", object: f %>
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/app/views/decidim/cleaner/inactive_users_mailer/warning_deletion.html.erb

@@ -0,0 +1,7 @@
+<p class="email-greeting"><%= t ".hello" %></p>
+
+<p class="email-instructions"><%= t(".body_1", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host), days: @organization.delete_inactive_users_after||390).html_safe %></p>
+
+<p class="email-instructions"><%= t ".body_2" %></p>
+
+<p class="email-closing"><%= t(".greetings", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>

data/app/views/decidim/cleaner/inactive_users_mailer/warning_inactive.html.erb

@@ -0,0 +1,7 @@
+<p class="email-greeting"><%= t ".hello" %></p>
+
+<p class="email-instructions"><%= t ".body_1", organization_name: h(@organization.name), days: @organization.delete_inactive_users_email_after %></p>
+
+<p class="email-instructions"><%= t(".body_2", remaining_days: (@organization.delete_inactive_users_after||390) - (@organization.delete_inactive_users_email_after||365), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>
+
+<p class="email-closing"><%= t(".greetings", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>

data/config/assets.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+base_path = File.expand_path("..", __dir__)
+
+Decidim::Webpacker.register_path("#{base_path}/app/packs")
+Decidim::Webpacker.register_entrypoints(
+  decidim_cleaner: "#{base_path}/app/packs/entrypoints/decidim_cleaner.js"
+)
+Decidim::Webpacker.register_stylesheet_import("stylesheets/decidim/cleaner/cleaner")

data/config/i18n-tasks.yml

@@ -0,0 +1,10 @@
+---
+
+base_locale: en
+locales: [en]
+
+ignore_unused:
+  - "decidim.components.cleaner.name"
+
+ignore_missing:
+  - decidim.participatory_processes.scopes.global

data/config/locales/en.yml

@@ -0,0 +1,38 @@
+---
+en:
+  activemodel:
+    attributes:
+      organization:
+        delete_admin_logs: Enable admin logs deletion
+        delete_admin_logs_after: Delete admin logs after (days, default 365)
+        delete_inactive_users: Enable inactive users deletion
+        delete_inactive_users_after: Delete inactive users after (days, default 390)
+        delete_inactive_users_email_after: Send email to inactive users before deletion (days, default 365)
+  decidim:
+    admin:
+      menu:
+        clean: Data cleaner
+    cleaner:
+      admin:
+        organization_cleaner:
+          edit:
+            update: Update
+          form:
+            admin_log_cleaner_title: Admin log
+            inactive_users_cleaner_title: Inactive users
+      inactive_users_mailer:
+        warning_deletion:
+          body_1: You are inactive since %{days} days on <a href="%{organization_url}"> %{organization_name} </a>.
+          body_2: As a result, your account has been deleted.
+          greetings: Greetings,<br/>%{organization_name}<br/><a href="%{organization_url}">%{organization_url}</a>
+          hello: Hello
+          subject: Your account has been deleted
+        warning_inactive:
+          body_1: You are inactive since %{days} days on %{organization_name}.
+          body_2: <a href="%{organization_url}">If no reaction within %{remaining_days} days </a>, your account will be deleted.
+          greetings: Greetings,<br/>%{organization_name}<br/><a href="%{organization_url}">%{organization_url}</a>
+          hello: Hello
+          subject: Your account is inactive
+    components:
+      cleaner:
+        name: Cleaner

data/config/locales/fr.yml

@@ -0,0 +1,38 @@
+---
+fr:
+  activemodel:
+    attributes:
+      organization:
+        delete_admin_logs: Activer la suppression de l'historique d'administration
+        delete_admin_logs_after: Supprimer l'historique d'administration après (jours, par défaut 365)
+        delete_inactive_users: Activer la suppression des utilisateurs inactifs
+        delete_inactive_users_after: Supprimer les utilisateurs inactifs après (jours, par défaut 390)
+        delete_inactive_users_email_after: Envoyer un courriel aux utilisateurs inactifs avant la suppression (jours, par défaut 365)
+  decidim:
+    admin:
+      menu:
+        clean: Nettoyeur de données
+    cleaner:
+      admin:
+        organization_cleaner:
+          edit:
+            update: Mettre à jour
+          form:
+            admin_log_cleaner_title: Historique d'administration
+            inactive_users_cleaner_title: Utilisateurs inactifs
+      inactive_users_mailer:
+        warning_deletion:
+          body_1: Vous êtes inactif depuis %{days} jours sur <a href="%{organization_url}"> %{organization_name} </a>.
+          body_2: Par conséquent, votre compte a été supprimé.
+          greetings: Cordialement,<br/>%{organization_name}<br/><a href="%{organization_url}">%{organization_url}</a>
+          hello: Bonjour
+          subject: Votre compte a été supprimé
+        warning_inactive:
+          body_1: Vous êtes inactif depuis %{days} jours sur %{organization_name}.
+          body_2: <a href="%{organization_url}">Si aucune réaction dans les %{remaining_days} jours</a>, votre compte sera supprimé.
+          greetings: Cordialement,<br/>%{organization_name}<br/><a href="%{organization_url}">%{organization_url}</a>
+          hello: Bonjour
+          subject: Votre compte est inactif
+    components:
+      cleaner:
+        name: Nettoyeur

data/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# frozen_string_litteral: true
+
+Decidim::Admin::Engine.routes.draw do
+  resource :organization, controller: "organization" do
+    resource :cleaner, only: [:edit, :update], controller: "/decidim/cleaner/admin/organization_cleaner"
+  end
+end

data/db/migrate/20230106105014_add_delete_admin_logs_to_organization.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddDeleteAdminLogsToOrganization < ActiveRecord::Migration[6.0]
+  def change
+    add_column :decidim_organizations, :delete_admin_logs, :boolean, default: false, null: false
+    add_column :decidim_organizations, :delete_admin_logs_after, :integer
+  end
+end

data/db/migrate/20230110150032_add_delete_inactive_users_to_organization.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddDeleteInactiveUsersToOrganization < ActiveRecord::Migration[6.0]
+  def change
+    add_column :decidim_organizations, :delete_inactive_users, :boolean, default: false, null: false
+    add_column :decidim_organizations, :delete_inactive_users_email_after, :integer
+    add_column :decidim_organizations, :delete_inactive_users_after, :integer
+  end
+end

data/lib/decidim/cleaner/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    # This module contains all the domain logic associated to Decidim's Cleaner
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/cleaner/admin_engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    # This is the engine that runs on the public interface of `Cleaner`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Cleaner::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      initializer "decidim_admin.admin_settings_menu" do
+        Decidim.menu :admin_settings_menu do |menu|
+          menu.add_item :clean_organization,
+                        I18n.t("menu.clean", scope: "decidim.admin"),
+                        decidim_admin.edit_organization_cleaner_path,
+                        position: 1.8,
+                        if: allowed_to?(:update, :organization, organization: current_organization),
+                        active: is_active_link?(decidim_admin.edit_organization_cleaner_path)
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end