Class: JekyllImport::Importers::S9YDatabase
- Inherits:
-
JekyllImport::Importer
- Object
- JekyllImport::Importer
- JekyllImport::Importers::S9YDatabase
- Defined in:
- lib/jekyll-import/importers/s9y_database.rb
Class Method Summary collapse
- .clean_entities(text) ⇒ Object
- .page_path(page_id, page_name_list) ⇒ Object
-
.process(opts) ⇒ Object
Main migrator function.
- .process_categories(db, options, post) ⇒ Object
- .process_comments(db, options, post) ⇒ Object
- .process_permalink(db, options, post) ⇒ Object
- .process_post(post, db, options, page_name_list) ⇒ Object
- .process_tags(db, options, post) ⇒ Object
- .require_deps ⇒ Object
- .require_if_available(gem_name, option_name) ⇒ Object
- .sluggify(title) ⇒ Object
- .specify_options(c) ⇒ Object
Methods inherited from JekyllImport::Importer
inherited, run, stringify_keys, subclasses
Class Method Details
.clean_entities(text) ⇒ Object
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 323 def self.clean_entities(text) text.force_encoding("UTF-8") if text.respond_to?(:force_encoding) text = HTMLEntities.new.encode(text, :named) # We don't want to convert these, it would break all # HTML tags in the post and comments. text.gsub!("&", "&") text.gsub!("<", "<") text.gsub!(">", ">") text.gsub!(""", '"') text.gsub!("'", "'") text.gsub!("/", "/") text end |
.page_path(page_id, page_name_list) ⇒ Object
341 342 343 344 345 346 347 348 349 350 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 341 def self.page_path(page_id, page_name_list) if page_name_list.key?(page_id) [ page_name_list[page_id][:slug], "/", ].join("") else "" end end |
.process(opts) ⇒ Object
Main migrator function. Call this to perform the migration.
- dbname
-
The name of the database
- user
-
The database user name
- pass
-
The database user’s password
- host
-
The address of the MySQL database host. Default: ‘localhost’
- port
-
The port of the MySQL database server. Default: 3306
- socket
-
The database socket’s path
- options
-
A hash table of configuration options.
Supported options are:
- :table_prefix
-
Prefix of database tables used by WordPress. Default: ‘serendipity_’
- :clean_entities
-
If true, convert non-ASCII characters to HTML entities in the posts, comments, titles, and names. Requires the ‘htmlentities’ gem to work. Default: true.
- :comments
-
If true, migrate post comments too. Comments are saved in the post’s YAML front matter. Default: true.
- :categories
-
If true, save the post’s categories in its YAML front matter. Default: true.
- :tags
-
If true, save the post’s tags in its YAML front matter. Default: true.
- :extension
-
Set the post extension. Default: “html”
- :drafts
-
If true, export drafts as well Default: true.
- :markdown
-
If true, convert the content to markdown Default: false
- :permalinks
-
If true, save the post’s original permalink in its YAML front matter. Default: false.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 68 def self.process(opts) = { :user => opts.fetch("user", ""), :pass => opts.fetch("password", ""), :host => opts.fetch("host", "localhost"), :port => opts.fetch("port", 3306), :socket => opts.fetch("socket", nil), :dbname => opts.fetch("dbname", ""), :table_prefix => opts.fetch("table_prefix", "serendipity_"), :clean_entities => opts.fetch("clean_entities", true), :comments => opts.fetch("comments", true), :categories => opts.fetch("categories", true), :tags => opts.fetch("tags", true), :extension => opts.fetch("extension", "html"), :drafts => opts.fetch("drafts", true), :markdown => opts.fetch("markdown", false), :permalinks => opts.fetch("permalinks", false), } [:clean_entities] = require_if_available("htmlentities", "clean_entities") if [:clean_entities] [:markdown] = require_if_available("reverse_markdown", "markdown") if [:markdown] FileUtils.mkdir_p("_posts") FileUtils.mkdir_p("_drafts") if [:drafts] db = Sequel.mysql2([:dbname], :user => [:user], :password => [:pass], :socket => [:socket], :host => [:host], :port => [:port], :encoding => "utf8") px = [:table_prefix] page_name_list = {} page_name_query = %( SELECT entries.ID AS `id`, entries.title AS `title` FROM #{px}entries AS `entries` ) db[page_name_query].each do |page| page[:slug] = sluggify(page[:title]) page_name_list[ page[:id] ] = { :slug => page[:slug], } end posts_query = " SELECT entries.ID AS `id`, entries.isdraft AS `isdraft`, entries.title AS `title`, entries.timestamp AS `timestamp`, entries.body AS `body`, entries.extended AS `body_extended`, authors.realname AS `author`, authors.username AS `author_login`, authors.email AS `author_email` FROM #{px}entries AS `entries` LEFT JOIN #{px}authors AS `authors` ON entries.authorid = authors.authorid" posts_query << "WHERE posts.isdraft = 'false'" unless [:drafts] db[posts_query].each do |post| process_post(post, db, , page_name_list) end end |
.process_categories(db, options, post) ⇒ Object
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 214 def self.process_categories(db, , post) return [] unless [:categories] px = [:table_prefix] cquery = %( SELECT categories.category_name AS `name` FROM #{px}entrycat AS `entrycat`, #{px}category AS `categories` WHERE entrycat.entryid = '#{post[:id]}' AND entrycat.categoryid = categories.categoryid ) db[cquery].each_with_object([]) do |category, categories| categories << if [:clean_entities] clean_entities(category[:name]) else category[:name] end end end |
.process_comments(db, options, post) ⇒ Object
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 239 def self.process_comments(db, , post) return [] unless [:comments] px = [:table_prefix] cquery = %( SELECT id AS `id`, author AS `author`, email AS `author_email`, url AS `author_url`, timestamp AS `date`, body AS `content` FROM #{px}comments WHERE entry_id = '#{post[:id]}' AND status = 'approved' ) db[cquery].each_with_object([]) do |comment, comments| comcontent = comment[:content].to_s = comment[:author].to_s comcontent.force_encoding("UTF-8") if comcontent.respond_to?(:force_encoding) if [:clean_entities] comcontent = clean_entities(comcontent) = clean_entities() end comments << { "id" => comment[:id].to_i, "author" => , "author_email" => comment[:author_email].to_s, "author_url" => comment[:author_url].to_s, "date" => comment[:date].to_s, "content" => comcontent, } end.sort! { |a, b| a["id"] <=> b["id"] } end |
.process_permalink(db, options, post) ⇒ Object
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 303 def self.process_permalink(db, , post) return unless [:permalinks] px = [:table_prefix] cquery = %( SELECT permalinks.permalink AS `permalink` FROM #{px}permalinks AS `permalinks` WHERE permalinks.entry_id = '#{post[:id]}' AND permalinks.type = 'entry' ) db[cquery].each do |link| return "/#{link[:permalink]}" end end |
.process_post(post, db, options, page_name_list) ⇒ Object
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 143 def self.process_post(post, db, , page_name_list) extension = [:extension] title = post[:title] title = clean_entities(title) if [:clean_entities] slug = post[:slug] slug = sluggify(title) if !slug || slug.empty? status = post[:isdraft] == "true" ? "draft" : "published" date = Time.at(post[:timestamp]).utc || Time.now.utc name = format("%02d-%02d-%02d-%s.%s", date.year, date.month, date.day, slug, extension) content = post[:body].to_s content += "\n\n" + post[:body_extended].to_s unless post[:body_extended].to_s.empty? content = clean_entities(content) if [:clean_entities] content = ReverseMarkdown.convert(content) if [:markdown] categories = process_categories(db, , post) comments = process_comments(db, , post) = (db, , post) permalink = process_permalink(db, , post) # Get the relevant fields as a hash, delete empty fields and # convert to YAML for the header. data = { "layout" => post[:type].to_s, "status" => status.to_s, "published" => status.to_s == "draft" ? nil : (status.to_s == "published"), "title" => title.to_s, "author" => { "display_name" => post[:author].to_s, "login" => post[:author_login].to_s, "email" => post[:author_email].to_s, }, "author_login" => post[:author_login].to_s, "author_email" => post[:author_email].to_s, "date" => date.to_s, "permalink" => [:permalinks] ? permalink : nil, "categories" => [:categories] ? categories : nil, "tags" => [:tags] ? : nil, "comments" => [:comments] ? comments : nil, }.delete_if { |_k, v| v.nil? || v == "" }.to_yaml if post[:type] == "page" filename = page_path(post[:id], page_name_list) + "index.#{extension}" FileUtils.mkdir_p(File.dirname(filename)) elsif status == "draft" filename = "_drafts/#{slug}.#{extension}" else filename = "_posts/#{name}" end # Write out the data and content to file File.open(filename, "w") do |f| f.puts data f.puts "---" f.puts Util.wpautop(content) end end |
.process_tags(db, options, post) ⇒ Object
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 280 def self.(db, , post) return [] unless [:categories] px = [:table_prefix] cquery = %( SELECT entrytags.tag AS `name` FROM #{px}entrytags AS `entrytags` WHERE entrytags.entryid = '#{post[:id]}' ) db[cquery].each_with_object([]) do |tag, | << if [:clean_entities] clean_entities(tag[:name]) else tag[:name] end end end |
.require_deps ⇒ Object
6 7 8 9 10 11 12 13 14 15 16 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 6 def self.require_deps JekyllImport.require_with_fallback( %w( rubygems sequel fileutils safe_yaml unidecode ) ) end |
.require_if_available(gem_name, option_name) ⇒ Object
206 207 208 209 210 211 212 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 206 def self.require_if_available(gem_name, option_name) require gem_name true rescue LoadError warn "Could not require '#{gem_name}', so the :#{option_name} option is now disabled." true end |
.sluggify(title) ⇒ Object
337 338 339 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 337 def self.sluggify(title) title.to_ascii.downcase.gsub(%r![^0-9A-Za-z]+!, " ").strip.tr(" ", "-") end |
.specify_options(c) ⇒ Object
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/jekyll-import/importers/s9y_database.rb', line 18 def self.(c) c.option "dbname", "--dbname DB", "Database name (default: '')" c.option "socket", "--socket SOCKET", "Database socket (default: '')" c.option "user", "--user USER", "Database user name (default: '')" c.option "password", "--password PW", "Database user's password (default: '')" c.option "host", "--host HOST", "Database host name (default: 'localhost')" c.option "port", "--port PORT", "Custom database port connect to (default: 3306)" c.option "table_prefix", "--table_prefix PREFIX", "Table prefix name (default: 'serendipity_')" c.option "clean_entities", "--clean_entities", "Whether to clean entities (default: true)" c.option "comments", "--comments", "Whether to import comments (default: true)" c.option "categories", "--categories", "Whether to import categories (default: true)" c.option "tags", "--tags", "Whether to import tags (default: true)" c.option "drafts", "--drafts", "Whether to export drafts as well" c.option "markdown", "--markdown", "convert into markdown format (default: false)" c.option "permalinks", "--permalinks", "preserve S9Y permalinks (default: false)" end |