wordpressdotcom.rb

# frozen_string_literal: true

module JekyllImport
  module Importers
    class WordpressDotCom < Importer
      def self.require_deps
        JekyllImport.require_with_fallback(%w(
          rubygems
          fileutils
          safe_yaml
          nokogiri
          time
          open-uri
          open_uri_redirections
        ))
      end

      def self.specify_options(c)
        c.option "source",          "--source FILE",          "WordPress export XML file (default: 'wordpress.xml')"
        c.option "no_fetch_images", "--no-fetch-images",      "Do not fetch the images referenced in the posts (default: false)"
        c.option "assets_folder",   "--assets_folder FOLDER", "Folder where assets such as images will be downloaded to (default: 'assets')"
      end

      # Will modify post DOM tree
      def self.download_images(title, post_doc, assets_folder)
        images = post_doc.css("img")
        return if images.empty?

        Jekyll.logger.info "Downloading:", "images for #{title}"
        images.each do |i|
          uri = URI::DEFAULT_PARSER.escape(i["src"])

          dst = File.join(assets_folder, File.basename(uri))
          i["src"] = File.join("{{site.baseurl}}", dst)
          Jekyll.logger.info uri
          if File.exist?(dst)
            Jekyll.logger.info "Already in cache. Clean assets folder if you want a redownload."
            next
          end
          begin
            FileUtils.mkdir_p assets_folder
            OpenURI.open_uri(uri, :allow_redirections => :safe) do |f|
              File.open(dst, "wb") do |out|
                out.puts f.read
              end
            end
            Jekyll.logger.info "OK!"
          rescue StandardError => e
            Jekyll.logger.error "Error: #{e.message}"
            Jekyll.logger.error e.backtrace.join("\n")
          end
        end
      end

      class Item
        def initialize(node)
          raise "Node is nil" if node.nil?

          @node = node
        end

        def text_for(path)
          subnode = @node.at_xpath("./#{path}") || @node.at(path) || @node.children.find { |child| child.name == path }
          subnode.text
        end

        def title
          @title ||= text_for("title").strip
        end

        def permalink_title
          post_name = text_for("wp:post_name")
          # Fallback to "prettified" title if post_name is empty (can happen)
          @permalink_title ||= if post_name.empty?
                                 WordpressDotCom.sluggify(title)
                               else
                                 post_name
                               end
        end

        def permalink
          @permalink ||= begin
            uri = text_for("link")
            uri = @node.at("link").next_sibling.text if uri.empty?
            URI(uri.to_s.strip).path
          end
        end

        def published_at
          @published_at ||= Time.parse(text_for("wp:post_date")) if published?
        end

        def status
          @status ||= text_for("wp:status")
        end

        def post_password
          @post_password ||= text_for("wp:post_password")
        end

        def post_type
          @post_type ||= text_for("wp:post_type")
        end

        def parent_id
          @parent_id ||= text_for("wp:post_parent")
        end

        def file_name
          @file_name ||= if published?
                           "#{published_at.strftime("%Y-%m-%d")}-#{permalink_title}.html"
                         else
                           "#{permalink_title}.html"
                         end
        end

        def directory_name
          @directory_name ||= if !published? && post_type == "post"
                                "_drafts"
                              else
                                "_#{post_type}s"
                              end
        end

        def published?
          @published ||= (status == "publish")
        end

        def excerpt
          @excerpt ||= begin
            text = Nokogiri::HTML(text_for("excerpt:encoded")).text
            text.empty? ? nil : text
          end
        end
      end

      def self.process(options)
        source        = options.fetch("source", "wordpress.xml")
        fetch         = !options.fetch("no_fetch_images", false)
        assets_folder = options.fetch("assets_folder", "assets")
        FileUtils.mkdir_p(assets_folder)

        import_count = Hash.new(0)
        doc = Nokogiri::XML(File.read(source))
        # Fetch authors data from header
        authors = Hash[
          doc.xpath("//channel/wp:author").map do |author|
            [
              author.xpath("./wp:author_login").text.strip,
              {
                "login"        => author.xpath("./wp:author_login").text.strip,
                "email"        => author.xpath("./wp:author_email").text,
                "display_name" => author.xpath("./wp:author_display_name").text,
                "first_name"   => author.xpath("./wp:author_first_name").text,
                "last_name"    => author.xpath("./wp:author_last_name").text,
              },
            ]
          end
        ] rescue {}

        doc.css("channel > item").each do |node|
          item = Item.new(node)
          categories = node.css('category[domain="category"]').map(&:text).reject { |c| c == "Uncategorized" }.uniq
          tags = node.css('category[domain="post_tag"]').map(&:text).uniq

          metas = {}
          node.xpath("./wp:postmeta").each do |meta|
            key = meta.at_xpath("./wp:meta_key").text
            value = meta.at_xpath("./wp:meta_value").text
            metas[key] = value
          end

          author_login = item.text_for("dc:creator").strip

          header = {
            "layout"     => item.post_type,
            "title"      => item.title,
            "date"       => item.published_at,
            "type"       => item.post_type,
            "parent_id"  => item.parent_id,
            "published"  => item.published?,
            "password"   => item.post_password,
            "status"     => item.status,
            "categories" => categories,
            "tags"       => tags,
            "meta"       => metas,
            "author"     => authors[author_login],
            "permalink"  => item.permalink,
          }

          begin
            content = Nokogiri::HTML(item.text_for("content:encoded"))
            header["excerpt"] = item.excerpt if item.excerpt

            if fetch
              # Put the images into a /yyyy/mm/ subfolder to reduce clashes
              assets_dir_path = if item.published_at
                                  File.join(assets_folder, item.published_at.strftime("/%Y/%m"))
                                else
                                  assets_folder
                                end

              download_images(item.title, content, assets_dir_path)
            end

            FileUtils.mkdir_p item.directory_name
            File.open(File.join(item.directory_name, item.file_name), "w") do |f|
              f.puts header.to_yaml
              f.puts "---"
              f.puts Util.wpautop(content.to_html)
            end
          rescue StandardError => e
            Jekyll.logger.error "Couldn't import post!"
            Jekyll.logger.error "Title: #{item.title}"
            Jekyll.logger.error "Name/Slug: #{item.file_name}\n"
            Jekyll.logger.error "Error: #{e.message}"
            next
          end

          import_count[item.post_type] += 1
        end

        import_count.each do |key, value|
          Jekyll.logger.info "Imported", "#{value} #{Util.pluralize(key, value)}"
        end
      end

      def self.sluggify(title)
        title.gsub(%r![^[:alnum:]]+!, "-").downcase
      end
    end
  end
end