decidim-core 0.28.5 → 0.29.0.rc1

data/lib/decidim/content_parsers/blob_parser.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module Decidim
-  module ContentParsers
-    # Parses any blob URLs from the content and replaces them with references
-    # to those blobs.
-    class BlobParser < BaseParser
-      # Matches all possible URLs pointing to ActiveStorage::Blob objects.
-      #
-      # Possible routes:
-      # get "/blobs/redirect/:signed_id/*filename"
-      # get "/blobs/proxy/:signed_id/*filename"
-      # get "/blobs/:signed_id/*filename"
-      # get "/representations/redirect/:signed_blob_id/:variation_key/*filename"
-      # get "/representations/proxy/:signed_blob_id/:variation_key/*filename"
-      # get "/representations/:signed_blob_id/:variation_key/*filename"
-      # get  "/disk/:encoded_key/*filename"
-      #
-      # See:
-      # https://github.com/rails/rails/blob/a7e379896552ce43b822385c03c37f2bd47739d3/activestorage/config/routes.rb#L5-L14
-      BLOB_REGEX = %r{
-        # Group 1: Host part
-        (
-          # Group 2: Domain and subpath part
-          https?://((?!/rails).)+
-        )?
-        /rails/active_storage
-        # Group 3: Blob path, representation path or disk service path
-        /(blobs/redirect|blobs/proxy|blobs|representations/redirect|representations/proxy|representations|disk)
-        # Group 4: Signed ID for blobs or encoded key for disk service
-        /([^/]+)
-        # Group 5: Variation part (only for representations)
-        (
-          # Group 6: Variation key for representations
-          /([\w.=-]+)
-        )?
-        # Group 7: Filename
-        /([\w.=-]+)
-      }x
-
-      def rewrite
-        replace_blobs(content)
-      end
-
-      private
-
-      def replace_blobs(text)
-        text.gsub(BLOB_REGEX) do |match|
-          type_part = Regexp.last_match(3)
-          key_part = Regexp.last_match(4)
-
-          variation_key = nil
-          blob =
-            if type_part == "disk"
-              # Disk service URL
-              decoded = ActiveStorage.verifier.verified(key_part, purpose: :blob_key)
-              ActiveStorage::Blob.find_by(key: decoded[:key]) if decoded
-            else
-              # Representation or blob
-              if type_part.start_with?("representations")
-                # Representation
-                variation_part = Regexp.last_match(6)
-                variation_key = generate_variation_key(variation_part)
-              end
-
-              ActiveStorage::Blob.find_signed(key_part)
-            end
-          next match unless blob
-
-          "#{blob.to_global_id}#{"/#{variation_key}" if variation_key}"
-        end
-      end
-
-      def generate_variation_key(variation_part)
-        # The variation part has to be decoded because it will eventually
-        # expire. This way we can preserve the variation information
-        # longer.
-        variation = ActiveStorage.verifier.verify(variation_part, purpose: :variation)
-        return unless variation
-
-        # Convert to base64 encoded JSON string for better representation within
-        # the URLs. This manually encoded part will not expire as it is
-        # persisted to the database.
-        Base64.strict_encode64(ActiveSupport::JSON.encode(variation))
-      rescue ActiveSupport::MessageVerifier::InvalidSignature
-        # This happens if the variation key is already expired in which
-        # case it cannot be represented and instead a URL to the blob is
-        # created.
-        variation_part
-      end
-    end
-  end
-end

data/lib/decidim/content_renderers/blob_renderer.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-module Decidim
-  module ContentRenderers
-    # A renderer that searches Global IDs representing blobs in content and
-    # replaces it with a URL to these blobs.
-    #
-    # e.g. gid://<APP_NAME>/ActiveStorage::Blob/1
-    #
-    # OR for representations
-    #
-    # e.g. gid://<APP_NAME>/ActiveStorage::Blob/1/<encoded variant transformations>
-    #
-    # The `<encoded variant transformations>` part of the URL is a Base64
-    # encoded string that contains an unencrypted JSON-encoded value about the
-    # blob transformations. This way the specific representations can be stored
-    # in the database without having these values expiring.
-    #
-    # @see BaseRenderer Examples of how to use a content renderer
-    class BlobRenderer < BaseRenderer
-      # Matches a global id representing a Decidim::User
-      GLOBAL_ID_REGEX = %r{(gid://[\w-]+/ActiveStorage::Blob/\d+)(/([\w=-]+))?}
-
-      # Replaces found Global IDs matching an existing blob with a URL to
-      # that blob. The Global IDs representing an invalid ActiveStorage::Blob
-      # are replaced with an empty string.
-      #
-      # @return [String] the content ready to display (contains HTML)
-      def render(_options = nil)
-        replace_pattern(content, GLOBAL_ID_REGEX)
-      end
-
-      protected
-
-      def replace_pattern(text, pattern)
-        return text unless text.respond_to?(:gsub)
-
-        text.gsub(pattern) do
-          blob_gid = Regexp.last_match(1)
-          variation_key = Regexp.last_match(3)
-
-          blob = GlobalID::Locator.locate(blob_gid)
-          if variation_key
-            variation = begin
-              ActiveSupport::JSON.decode(Base64.strict_decode64(variation_key))
-            rescue JSON::ParseError
-              variation_key
-            end
-            blob_url(blob, variation)
-          else
-            blob_url(blob)
-          end
-        rescue ActiveRecord::RecordNotFound => _e
-          ""
-        end
-      end
-
-      def blob_url(blob, variation = nil)
-        url = begin
-          if variation
-            blob.variant(variation).url
-          else
-            blob.url
-          end
-        rescue ArgumentError
-          # ArgumentError is raised in case the blob's service is set to
-          # ActiveStorage::Service::DiskService and
-          # `ActiveStorage::Current.url_options` is not set.
-        end
-        raise URI::InvalidURIError if url.blank?
-
-        url
-      rescue URI::InvalidURIError
-        local_blob_url(blob, variation)
-      end
-
-      def local_blob_url(blob, variation = nil)
-        if variation
-          routes.rails_representation_url(blob.variant(variation), only_path: true)
-        else
-          routes.rails_blob_url(blob, only_path: true)
-        end
-      end
-
-      def routes
-        @routes ||= Rails.application.routes.url_helpers
-      end
-    end
-  end
-end

data/lib/decidim/seven_zip_wrapper.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "shellwords"
-
-module Decidim
-  class SevenZipWrapper
-    class << self
-      def compress_and_encrypt(filename:, password:, input_directory:)
-        run("cd #{escape(input_directory)} && 7z a -tzip -p#{escape(password)} -mem=AES256 #{escape(filename)} .")
-      end
-
-      def extract_and_decrypt(filename:, password:, output_directory:)
-        run("7z x -tzip #{escape(filename)} -o#{escape(output_directory)} -p#{escape(password)}")
-      end
-
-      private
-
-      def run(command)
-        success = system(command)
-
-        raise "Command failed: #{command}" unless success
-      end
-
-      def escape(string)
-        Shellwords.escape(string)
-      end
-    end
-  end
-end

data/lib/tasks/decidim_active_storage_migration_tasks.rake

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-namespace :decidim do
-  namespace :active_storage_migrations do
-    desc "Migrates attachments from Carrierwave to ActiveStorage"
-    task migrate_from_carrierwave_to_active_storage: :environment do
-      # Setup a new logger, using the timestamp to identify each migration
-      logger = ActiveSupport::TaggedLogging.new(Logger.new("log/#{Time.current.strftime("%Y%m%d%H%M")}_activestorage_migration.log"))
-      routes_mappings = []
-
-      Decidim::CarrierWaveMigratorService::MIGRATION_ATTRIBUTES.each do |(klass, cw_attribute, cw_uploader, as_attribute)|
-        Decidim::CarrierWaveMigratorService.migrate_attachment!({
-                                                                  klass:, cw_attribute:,
-                                                                  cw_uploader:, as_attribute:,
-                                                                  logger:,
-                                                                  routes_mappings:
-                                                                })
-      end
-      Decidim::CarrierWaveMigratorService.migrate_content_blocks_attachments!(logger:, routes_mappings:)
-
-      path = Rails.root.join("tmp/attachment_mappings.csv")
-      dirname = File.dirname(path)
-      FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
-      File.binwrite(path, Decidim::Exporters::CSV.new(routes_mappings).export.read)
-    end
-
-    desc "Checks attachments migrated from Carrierwave to ActiveStorage"
-    task check_migration_from_carrierwave_to_active_storage: :environment do
-      # Setup a new logger, using the timestamp to identify each migration
-      logger = ActiveSupport::TaggedLogging.new(Logger.new("log/#{Time.current.strftime("%Y%m%d%H%M")}_activestorage_migration_check.log"))
-      Decidim::CarrierWaveMigratorService::MIGRATION_ATTRIBUTES.each do |(klass, cw_attribute, cw_uploader, as_attribute)|
-        Decidim::CarrierWaveMigratorService.check_migration({
-                                                              klass:, cw_attribute:,
-                                                              cw_uploader:, as_attribute:,
-                                                              logger:
-                                                            })
-      end
-      Decidim::CarrierWaveMigratorService.check_content_blocks_attachments(logger:)
-    end
-
-    desc "Migrates inline images to ActiveStorage editor_image attachments"
-    task :migrate_inline_images_to_active_storage, [:admin_email] => :environment do |_t, args|
-      user = Decidim::User.find_by(email: args[:admin_email])
-
-      raise "Invalid admin. Please, provide the email of an admin with permissions to create editor images" unless user&.admin? && user&.admin_terms_accepted?
-
-      inline_images_available_attributes.each do |model, attributes|
-        puts "=== Updating model #{model.name} (attributes: #{attributes.join(", ")})..."
-        model.all.each do |item|
-          attributes.each do |attribute|
-            item.update(attribute => rewrite_value(item.send(attribute), user))
-          end
-        end
-        puts "=== Finished update of model #{model.name}\n\n"
-      end
-    end
-
-    def rewrite_value(value, user)
-      if value.is_a?(Hash)
-        value.transform_values do |nested_value|
-          rewrite_value(nested_value, user)
-        end
-      else
-        parser = Decidim::ContentParsers::InlineImagesParser.new(value, user:)
-        parser.rewrite
-      end
-    end
-
-    def inline_images_available_attributes
-      {
-        "Decidim::Accountability::Result" => %w(description),
-        "Decidim::Proposals::Proposal" => %w(body answer cost_report execution_period),
-        "Decidim::Votings::Voting" => %w(description),
-        "Decidim::Elections::Question" => %w(description),
-        "Decidim::Elections::Answer" => %w(description),
-        "Decidim::Elections::Election" => %w(description),
-        "Decidim::Initiative" => %w(description answer),
-        "Decidim::InitiativesType" => %w(description extra_fields_legal_information),
-        "Decidim::Assembly" => %w(short_description description purpose_of_action composition internal_organisation announcement closing_date_reason special_features),
-        "Decidim::Forms::Questionnaire" => %w(description tos),
-        "Decidim::Forms::Question" => %w(description),
-        "Decidim::Organization" => %w(
-          welcome_notification_body
-          admin_terms_of_use_body
-          admin_terms_of_service_body
-          description
-          highlighted_content_banner_short_description
-          id_documents_explanation_text
-        ),
-        "Decidim::StaticPage" => %w(content),
-        "Decidim::ContextualHelpSection" => %w(content),
-        "Decidim::Category" => %w(description),
-        "Decidim::Blogs::Post" => %w(body),
-        "Decidim::Pages::Page" => %w(body),
-        "Decidim::Sortitions::Sortition" => %w(additional_info witnesses cancel_reason),
-        "Decidim::Debates::Debate" => %w(description instructions information_updates conclusions),
-        "Decidim::Budgets::Budget" => %w(description),
-        "Decidim::Budgets::Project" => %w(description),
-        "Decidim::ConferenceSpeaker" => %w(short_bio),
-        "Decidim::Conferences::RegistrationType" => %w(description),
-        "Decidim::Conference" => %w(short_description description objectives registration_terms),
-        "Decidim::ParticipatoryProcessGroup" => %w(description),
-        "Decidim::ParticipatoryProcess" => %w(short_description description announcement),
-        "Decidim::ParticipatoryProcessStep" => %w(description),
-        "Decidim::Meetings::AgendaItem" => %w(description),
-        "Decidim::Meetings::Meeting" => %w(registration_terms description registration_email_custom_content closing_report)
-      }.each_with_object({}) do |(main_model, attributes), hash|
-        hash[main_model.constantize] = attributes
-      rescue NameError
-        hash
-      end
-    end
-  end
-end

data/lib/tasks/decidim_content_blocks_tasks.rake

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-namespace :decidim do
-  namespace :content_blocks do
-    desc "Initializes a default set of content blocks for each space whose landing page uses content blocks"
-    task :initialize_default_content_blocks, [:manifest_name, :space_id, :include_components] => :environment do |_task, args|
-      manifest_name = args[:manifest_name]
-      space_id = args[:space_id]&.to_i
-
-      raise "Please, provide a valid manifest name to find the space by id" if space_id.present? && manifest_name.blank?
-
-      include_components = args[:include_components] == "true"
-
-      valid_manifests = manifests_with_content_blocks
-      valid_manifests = valid_manifests.select { |manifest| manifest.name.to_s == manifest_name.to_s } if manifest_name.present?
-
-      raise "The #{manifest_name} spaces do not exist or have content blocks" if manifest_name.present? && valid_manifests.blank?
-
-      valid_manifests.each do |manifest|
-        spaces = resources_for(manifest)
-        spaces = spaces.select { |space| space.id == space_id } if space_id.present?
-
-        spaces.each do |space|
-          content_blocks_creator = Decidim::ContentBlocksCreator.new(space)
-          content_blocks_creator.create_default!
-
-          content_blocks_creator.create_components_blocks! if include_components
-        end
-      end
-    end
-
-    def manifests_with_content_blocks
-      [
-        Decidim.participatory_space_manifests,
-        Decidim.resource_manifests
-      ].map do |manifests|
-        manifests.select { |manifest| manifest.content_blocks_scope_name.present? }
-      end.flatten
-    end
-
-    def resources_for(manifest)
-      return manifest.participatory_spaces.call(Decidim::Organization.all) if manifest.respond_to?(:participatory_spaces)
-      return manifest.model_class.all if manifest.respond_to?(:model_class)
-
-      []
-    end
-  end
-end

data/lib/tasks/upgrade/decidim_attachments.rake

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-namespace :decidim do
-  namespace :upgrade do
-    desc "Cleanup the orphaned blobs attachments"
-    task :attachments_cleanup, [:clean_up_unattached_blobs_after_in_minutes] => :environment do |_task, args|
-      args.with_defaults(clean_up_unattached_blobs_after_in_minutes: 60)
-
-      clean_up_unattached_blobs_after_in_minutes = args[:clean_up_unattached_blobs_after_in_minutes].to_i
-
-      ActiveStorage::Blob.unattached.where(created_at: ..clean_up_unattached_blobs_after_in_minutes.minutes.ago).find_each(batch_size: 100, &:purge_later)
-    end
-  end
-end