Fuuka Imageboard Archival Standard (Fuuka)

Note: Not to be confused with the FoolFuuka frontend, which uses the Asagi scraper.

https://github.com/eksopl/fuuka/wiki/Sphinx-Search-Backend#gory-details

Asagi Imageboard Archival Standard (Asagi)

The Asagi Imageboard Archival Standard was developed by eksopl of Easymodo and the Foolz team under the direction of woxxy. It was developed to run the Foolz archiver, and has been the engine for the majority of archivers since the collapse of Archive.moe.

SQL Schema

Two versions of the SQL Schema in use can be identified:

1.0.0 (2013) - The final version by Eksopl for Foolz.us, and the SQL schema was unchanged in Archive.moe.
- Should be used by Fireden, but this is unknown.
- Might be still used by Nyafuu, was in use by Loveisover.
1.3.0 (2019) - (only Mysql/triggers.sql was changed, no other structural SQL schema changes) The final reference standard consolidated from 4plebs repos by the Bibliotheca Anonoma for use in Desuarchive, in preparation for the development of new drop-in replacements.
- Used by Desuarchive, Rbt, arch.b4k.co, maybe 4plebs?

A refined version 2.0.0 is proposed that would eliminate SQL triggers for improved performance, instead leaving it up to the scraper engines to conduct similar operations as the triggers.

Reference Implementation

Operating System: Ubuntu 14.04/16.04 LTS
Database: MySQL Compatible utf8mb4
- Despite the fact that PostgreSQL is supported by Asagi Scraper, it is not supported by FoolFuuka.
Scraper: Asagi (Java) - https://github.com/bibanon/asagi
Frontend: FoolFuuka (PHP) - https://github.com/bibanon/FoolFuuka
PHP Engine: Historically HHVM, PHP5.x compatible. Desuarchive and 4plebs now uses PHP 7.
Search: Sphinxsearch

New Implementation

Proposed, still needs to be constructed.

Database: Percona MariaDB TokuDB - Special variant of MariaDB with many unique optimizations.
Scraper: baystdev/Hayden (.NET C#)
Frontend: https://github.com/pleebe/FoolFuuka/tree/experimental
New Frontend: some python based 4chan API compatible middleware

Compilation and Usage

Asagi

https://github.com/eksopl/asagi/wiki/Running-Asagi

Also check FoolFuuka/Install/Ubuntu16#Install_and_compile_Asagi_from_source.

FoolFuuka

https://blog.foolz.us/

Also check FoolFuuka/Install/Ubuntu16

How Asagi does stuff

Configuration

For example here is the config for Desuarchive:

{"settings": {
  "dumperEngine": "DumperJSON",
  "sourceEngine": "YotsubaJSON",

  "boardSettings": {
    "default": {
      "engine": "Mysql",
      "database": "asagi",
      "host": "localhost",
      "username": "asagi",
      "password": "YOUR_PASSWORD_HERE,
      "charset": "utf8mb4",
      "path": "/srv/foolfuuka/boards",
      "updateFileLastModified": false,
      "useOldDirectoryStructure": false,
      "webserverGroup": "www-data",
      "thumbThreads": 2,
      "mediaThreads": 2,
      "newThreadsThreads": 6,
      "deletedThreadsThresholdPage": 8,
      "refreshDelay": 60,
      "throttleAPI": false,
      "throttleURL": "i.4cdn.org",
      "throttleMillisec": 1050,
      "threadRefreshRate": 50
    },

    "mlp": {},
    "qa": {},
    "aco": {},
    "tg": {},
    "d": {},
    "co": {},
    "a": {},
    "an": {},
    "k": {},
    "fit": {},
    "wsg": {"mediaThreads": 0},
    "gif": {"mediaThreads": 0},
    "r9k": {},
    "int": {},
    "c": {},
    "m": {},
    "vr": {},
    "his": {},
    "trash": {},
    "cgl": {},
    "g": {},
    "mu": {}
  }
}}

Misc

Seperate thread for (thumbs, media, topic-fetch, topic-insert, post-delete) per board

AbstractDumper.java ln. 95: public void initDumper(BoardSettings boardSettings) {

How Asagi decides to update a thread:

In initDumper(), DumperJSON spawns an instance of its inner class BoardPoller on a thread. In its run() method, BoardPoller loops indefinitely:

Wake up from sleeping (duration set by refreshDelay in the configuration)
threadList = sourceBoard.getAllThreads(lastMod);
If the request 304s or errors, go to sleep
Go over the previous threads:
- If this thread is in the current threads and it’s been modified, mark its modification timestamp and page number. Then, push it to newTopics.
- If this thread is not in the current threads, it’s been deleted. Push it to newTopics.
Put the remaining threads in newTopics
Sleep until the delay expires

The queue newTopics is processed by AbstractDumper’s inner class TopicFetcher.

When Asagi does a thread update:

in : YotsubaJSON.java, ln. 88: public Topic getThread(int threadNum, String lastMod) throws ContentGetException, ContentParseException, CfBicClearParseException {

Loads thread JSON Decodes JSON For each post in the decoded thread JSON: Check if resto value is zero, and if so create a new thread from that post, updating lastmodified time to the time from fetching the JSON. t = this.makeThreadFromJson(pj); If resto is zero: Add the post to the current thread. t.addPost(this.makePostFromJson(pj)); (What if two posts were resto==0? We’d break!)

What does Asagi do with a post in a thread?

Relevant files: >YousubaJSON.java >YotsubaAbstract.java

The entire thread is processed at once.

For OP:

In YousubaJSON.java, ln. 217: private Topic makeThreadFromJson(PostJson pj) throws ContentParseException {

Ensure post number is zero. Create a new Topic() object (ln222): Topic t = new Topic(pj.getNo(), pj.getOmittedPosts(), pj.getOmittedImages());

Add the supplied OP to the thread as any other would be (ln. 224): t.addPost(this.makePostFromJson(pj));

Return the Thread() object. DONE

For reply:

In YotsubaJSON.java, (ln. 157:) private Post makePostFromJson(PostJson pj) throws ContentParseException {

Ensure post number is valid. Ensure time is valid. Create new Post() object.

If the JSON gave a filename not equal to null: Generate filename from JSON values. p.setMediaFilename(pj.getFilename() + pj.getExt());

Generate original filename from JSON values. p.setMediaOrig(pj.getTim() + pj.getExt());

Generate preview original filename from JSON values. p.setPreviewOrig(pj.getTim() + "s.jpg");

Find the post’s capcode, and if not null: Manager -> “G” Anything else: first character as uppercase.

Find the post hash (tripcode?) If the post hash is “Developer”, set the post hash value to “Dev”

If the post country is not null: Convert values “XX” or “A1” if they are used to null.

Pass through values from JSON YotsubaJSON.java (ln. 188 -> 212), doing the following conversions:

Thread num to the current thread number: .setThreadNum(pj.getResto() == 0 ? pj.getNo() : pj.getResto());

OP status YotsubaJSON.java (ln. 197): p.setOp(pj.getResto() == 0);

Sanitized title? YotsubaJSON.java (ln. 198): p.setTitle(this.cleanSimple(pj.getSub()));

See YotsubaAbstract.java (ln.83): public String doClean(String text)

Sanitized name YotsubaJSON.java (ln. 200): p.setName(this.cleanSimple(pj.getName()));

Date converted from NYC_TIMEZONE (ln. 202): p.setDate(DateUtils.adjustTimestampEpoch(pj.getTime(), DateUtils.NYC_TIMEZONE));

Sanitized? EXIF data YotsubaJSON.java (ln. 212): p.setExif(this.cleanSimple(this.parseMeta(pj.getCom(), pj.getUniqueIps(), pj.getSince4pass(), pj.getTrollCountry()))); Return the Post() object.

How Asagi handles an image in a thread?

Files of note: >Local.java - Saving image files

Local.java ln.201: public void insertMedia(MediaPost h, Board source, boolean isPreview) throws ContentGetException, ContentStoreException, CfBicClearParseException {

How Asagi deals with post deletions?

Relevant files: >src.java >src.java >src.java

SQL That handles post deletion logic: SQL.java (ln. 94): “this.updateDeletedQuery = String.format("UPDATE \"%s\" SET deleted = ?, timestamp_expired = ? WHERE num = ? AND subnum = ?", this.table);

This is prepared into statement, SQL.java (ln.62): updateDeletedStmt = conn.prepareStatement(updateDeletedQuery);

Function that actually writes deleted flag to a post: SQL.java (ln. 267): public synchronized void markDeleted(DeletedPost post) throws ContentStoreException, DBConnectionException {

Class TopicFetcher has function run() which calls findDeleted() See AbstractDumper.java (ln. 268): protected class TopicFetcher implements Runnable {

And AbstractDumper.java (ln. 380): findDeleted(oldTopic, topic, true);

Function findDeleted() checks Posts in a Topic to check if they have been removed in AbstractDumper.java (ln. 103): protected boolean findDeleted(Topic oldTopic, Topic newTopic, boolean markDeleted) {

Function markDeleted() in Local.java calls function markDeleted() from SQL.java: Local.java (ln. 185): public void markDeleted(DeletedPost post) throws ContentStoreException {

SQL.java (ln. 267): public synchronized void markDeleted(DeletedPost post) throws ContentStoreException, DBConnectionException {

How Asagi interacts with the database?

Relevant files: >SQL.java >Mysql.java

Inserting a thread: SQL.java, ln.196: public synchronized void insert(Topic topic) throws ContentStoreException, DBConnectionException { Each post in the current Topic object is fed through the insert statement sequentially.

How each value is processed between 4ch and the DB

4chan API JSON broken down to post level (YoutsubaJSON.java ln.97), then: ?PostJson are created/populated from the thread JSON data, with values keeping the names from the API? (PostJson.java, ln.4) (DISREGARD CAPITALIZATION, GOOG DOCS FUCKS WITH IT. EVERYTHING IS LOWERCASE) DB column names referenced here: (SQL.java ln.79):

(poster_ip,
num,
subnum,
thread_num,
op,
timestamp,
preview_orig,
preview_w,
preview_h,
media_filename,
media_w,
media_h,
media_size,
media_hash,
media_orig,
spoiler,
deleted,
capcode,
email,
name,
trip,
title,
comment,
delpass,
sticky,
locked,
poster_hash,
poster_country,
exif)

4ch → (Asagi) → DB

“poster_ip”

Presumably always NULL? PROVEME Does not appear to ever be initialized to a value in the java source code as far as i can tell?

“no” - > “num”

Post ID number from 4chan. Passed through as-is.

“subnum”

Ghostpost ID number for foolfuuka. Always zero.?

“Thread_num”

Thread IP number, always Post ID number of OP. “num” of thread OP (YoutsubaJSON.java, ln. 196): “p.setThreadNum(pj.getResto() == 0 ? pj.getNo() : pj.getResto());”

“Time” ->“timestamp”

Timestamp of post. 4ch API provides as milliseconds since 1 JAN 1970 in USA NYC timezone. DB stores as ?(Probably milliseconds since 1 JAN 1970 UTC+0) (YoutsubaJSON.java, ln. 202): p.setDate(DateUtils.adjustTimestampEpoch(pj.getTime(), DateUtils.NYC_TIMEZONE));

“resto” -> (If resto is 0, use value from “num”) -> op

Is this the OP of the thread? (YoutsubaJSON.java, ln. 197): p.setOp(pj.getResto() == 0);

N/A -> Preview_orig

(YoutsubaJSON.java, ln. 170): p.setPreviewOrig(pj.getTim() + "s.jpg");

“tn_w” -> “preview_w”

Width of media thumbnail (YoutsubaJSON.java, ln. 193): p.setPreviewW(pj.getTnW());

“tn_h” -> “preview_h”

Height of media thumbnail. (YoutsubaJSON.java, ln. 170): p.setPreviewH(pj.getTnH());

N/A -> media_filename

(YoutsubaJSON.java, ln. 168): p.setMediaFilename(pj.getFilename() + pj.getExt());

“W” -> “media_w”

(YoutsubaJSON.java, ln. 191): p.setMediaW(pj.getW());

“h” -> “media_h”

(YoutsubaJSON.java, ln. 192): p.setMediaH(pj.getH());

“Media_size”

(YoutsubaJSON.java, ln. 190): p.setMediaSize(pj.getFsize());

“Media_hash”

(YoutsubaJSON.java, ln. 189): p.setMediaHash(pj.getMd5());

N/A -> “Media_orig”

(YoutsubaJSON.java, ln. 169): p.setMediaOrig(pj.getTim() + pj.getExt());

“Spoiler”

(YoutsubaJSON.java, ln. 204): p.setSpoiler(pj.isSpoiler());

N/A -> “Deleted”

Set initially as false, then later updated if post is later absent from thread during subsequent updates. (YoutsubaJSON.java, ln. 205): p.setdeleted(false);

“Capcode” -> “Capcode”

(YoutsubaJSON.java, ln. 173):

String capcode = pj.getCapcode();
if (capcode != null) {
    if (capcode.equals("manager") || capcode.equals("Manager")) {
        capcode = "G";
    } else {
        capcode = capcode.substring(0, 1).toUpperCase();
    }
}

“email” -> “Email”

(YoutsubaJSON.java, ln. 199): p.setEmail(pj.getEmail());

“Name” -> (cleanSimple()) -> “Name”

(YoutsubaJSON.java, ln. 200): p.setName(this.cleanSimple(pj.getName()));

“trip” -> “Trip”

(YoutsubaJSON.java, ln. XX): p.setTrip(pj.getTrip());

“sub” -> (cleanSimple()) -> “Title”

(YoutsubaJSON.java, ln. 198): p.setTitle(this.cleanSimple(pj.getSub()));

“com” -> (doClean) -> “Comment”

(YoutsubaJSON.java, ln. 203): p.setComment(this.doClean(pj.getCom()));

N/A -> “Delpass”

TODO (YoutsubaJSON.java, ln. XX): TODO

“sticky” -> “Sticky”

(YoutsubaJSON.java, ln. 206): p.setSticky(pj.isSticky());

“closed”, “archived” -> “closed” AND (NOT “archived”)) -> “Locked”

(YoutsubaJSON.java, ln. 207): p.setClosed(pj.isClosed() && !pj.isArchived()); (SQL.java, ln. 78 - 86): this.insertQuery = String.format( (SQL.java, ln. 236): insertStmt.setBoolean(c++, post.isClosed());

“id” -> “Poster_hash”

(YoutsubaJSON.java, ln. 182):

String posterHash = pj.getId();
if(posterHash != null && posterHash.equals("Developer")) posterHash = "Dev";

“country” -> “Poster_country”

(YoutsubaJSON.java, ln. 185-186):

String posterCountry = pj.getCountry();
if(posterCountry != null && (posterCountry.equals("XX") || posterCountry.equals("A1"))) posterCountry = null;

lots -> “exif”

(YoutsubaJSON.java, ln. 212): p.setExif(this.cleanSimple(this.parseMeta(pj.getCom(), pj.getUniqueIps(), pj.getSince4pass(), pj.getTrollCountry()))); (YoutsubaAbstract.java, ln. 137): public String parseMeta(String text, Integer uniqueIps, Integer since4pass, String trollCountry) {

Images table values:

These seem to be handled by triggers that run on post insert.

4ch -> (Asagi) -> DB

N/A -> (Incremental integer) -> “media_id”

This is simply an autoincrementing integer value. Set by DB engine if new image. Set by trigger if already-seen image. (Triggers.sql ln.119-139): - If the md5 is already in the DB media_id = LAST_INSERT_ID(media_id),

md5 -> (N/A) -> “media_hash”

The base64-encoded md5 hash of the media file as given by 4ch. (SQL.java ln.77-87) Omitted for brevity

N/A -> (Local filepath to full image) -> “media”

The relative path to the image on disk. (Triggers.sql ln.119-139): TODO

N/A -> (Local filepath to OP thumbnail) -> “preview_op”

The relative path to the image on disk. (Triggers.sql ln.119-139): TODO

N/A -> (Local filepath to reply thumbnail) -> “preview_reply”

The relative path to the image on disk. (Triggers.sql ln.119-139): TODO

N/A -> (incrementer) -> “total”

The number of posts that refer to this row.

(Triggers.sql ln.123): INSERT INTO \"%%BOARD%%\_images\" (media\_hash, media, preview\_op, total)

(Triggers.sql ln.127): total = (total + 1)

N/A -> (N/A) -> “banned”

Not set by Asagi, but observed to prevent downloading banned files (Triggers.sql ln.119-139): TODO

Table definition

(Boards.sql ln.38-49): - Table definition

CREATE TABLE %%BOARD%%_images ( media_id SERIAL NOT NULL, media_hash character varying(25) NOT NULL, media character varying(20), preview_op character varying(20), preview_reply character varying(20), total integer NOT NULL DEFAULT ‘0’, banned smallint NOT NULL DEFAULT ‘0’, PRIMARY KEY (media_id), UNIQUE (media_hash) );

Image insert procedure

(Triggers.sql ln.119-139): - Image insert procedure

DROP PROCEDURE IF EXISTS “insert_image_%%BOARD%%”; CREATE PROCEDURE “insert_image_%%BOARD%%” (n_media_hash VARCHAR(25), n_media VARCHAR(20), n_preview VARCHAR(20), n_op INT) BEGIN IF n_op = 1 THEN INSERT INTO "%%BOARD%%_images" (media_hash, media, preview_op, total) VALUES (n_media_hash, n_media, n_preview, 1) ON DUPLICATE KEY UPDATE media_id = LAST_INSERT_ID(media_id), total = (total + 1), preview_op = COALESCE(preview_op, VALUES(preview_op)), media = COALESCE(media, VALUES(media)); ELSE INSERT INTO "%%BOARD%%_images" (media_hash, media, preview_reply, total) VALUES (n_media_hash, n_media, n_preview, 1) ON DUPLICATE KEY UPDATE media_id = LAST_INSERT_ID(media_id), total = (total + 1), preview_reply = COALESCE(preview_reply, VALUES(preview_reply)), media = COALESCE(media, VALUES(media)); END IF; END; ```

Data path:

4ch -> decode JSON -> make Post objects

API Date is retrieved from 4ch and put into TopicJson objects, ready for handling posts in each of those topics. (YoutsubaJSON.java ln .89): - Get 4ch API JSON String[] wgetReply = this.wgetText(this.linkThread(threadNum), lastMod); (YoutsubaJSON.java ln .97) - Decode JSON into TopicJson objects topicJson = GSON.fromJson(threadText, TopicJson.class); (YoutsubaJSON.java ln .93) V For a single topic, each post if decoded into a Post object Post object -> added to Topic object (YoutsubaJSON.java ln .93): - Create Topic object Topic t = null;

(YoutsubaJSON.java ln .109): - OP t = this.makeThreadFromJson(pj);

(YoutsubaJSON.java ln .116): - Reply t.addPost(this.makePostFromJson(pj));

V

(AbstractDumper.java ln 303): topic = sourceBoard.getThread(newTopic, lastMod);

V

Image processed somehow?

Full image fetching begins

(AbstractDumper.java ln 161): - Fullsize media downloader thread protected class MediaFetcher implements Runnable { (AbstractDumper.java lln. 169): - Grab from queue thing mediaPost = mediaUpdates.take(); (AbstractDumper.java lln. 173): - Try to handle the media for one post mediaLocalBoard.insertMedia(mediaPost, sourceBoard); (Local.java ln. 201): - Handler for a post with media public void insertMedia(MediaPost h, Board source, boolean isPreview) throws ContentGetException, ContentStoreException, CfBicClearParseException { (Local.java ln. 201): - Interact with DB for this media mediaRow = db.getMedia(h);

If there is information for this media in the DB, retrieve it. If any new information exists about this media that is not already in the DB, add that to the DB entry. (SQL.java ln. 289): - Interact with DB for this media public synchronized Media getMedia(MediaPost post) throws ContentGetException, ContentStoreException, DBConnectionException {

(SQL.java ln. 342-347): - Decide if media row needs an update

boolean mediaUpdate = media.getMedia() == null;
boolean previewOpUpdate = media.getPreviewOp() == null && post.isOp();
boolean previewReplyUpdate = media.getPreviewReply() == null && !post.isOp();
// Update media row in _images table when any of its entries are null and we actually have it
if(mediaUpdate || previewOpUpdate || previewReplyUpdate) {

(SQL.java ln. 349-373): - Add values to DB for this media

if(mediaUpdate) {
updateMediaStmt.setString(1, post.getMedia());
updateMediaStmt.setString(2, post.getMediaHash());
updateMediaStmt.executeUpdate();
}
if(previewOpUpdate) {
updatePreviewOpStmt.setString(1, post.getPreview());
updatePreviewOpStmt.setString(2, post.getMediaHash());
updatePreviewOpStmt.executeUpdate();
}
if(previewReplyUpdate) {
updatePreviewReplyStmt.setString(1, post.getPreview());
updatePreviewReplyStmt.setString(2, post.getMediaHash());
updatePreviewReplyStmt.executeUpdate();
}
conn.commit();

(SQL.java ln. 62-66): - Preparing for selecting / updating media

selectMediaStmt = conn.prepareStatement(selectMediaQuery);
updateMediaStmt = conn.prepareStatement(updateMediaQuery);
updatePreviewOpStmt = conn.prepareStatement(updatePreviewOpQuery);
updatePreviewReplyStmt = conn.prepareStatement(updatePreviewReplyQuery);

(SQL.java ln. 96-103): - SQL for selecting / updating media

this.selectMediaQuery = String.format("SELECT * FROM \"%s_images\" WHERE media_hash = ?",
this.table);
this.updateMediaQuery = String.format("UPDATE \"%s_images\" SET media = ? WHERE media_hash = ?",
this.table);
this.updatePreviewOpQuery = String.format("UPDATE \"%s_images\" SET preview_op = ? WHERE media_hash = ?",
this.table);
this.updatePreviewReplyQuery = String.format("UPDATE \"%s_images\" SET preview_reply = ? WHERE media_hash = ?",
this.table);

Threads table values:

Files of note:

SQL.java YoutsubaJSON.java Topic.java - Class definition boards.sql (ln.52) - Table definition triggers.sql

Functions of note:

SQL.java:

YoutsubaJSON.java:

(ln.217) “private Topic makeThreadFromJson(PostJson pj) throws ContentParseException {”

Topic.java

(Ln. 22) public Topic(int num, int omPosts, int omImages) {

Data flow: 4ch -> Asagi -> DB

?Seems to be handled by DB triggers.?

References:

Asagi source code used: Bibabon repo 2019-7 retrieved from https://github.com/bibanon/asagi with commit https://github.com/bibanon/asagi/commit/dace6f01664d887f9f60dfdec341e626685b542f

Hayden source code : https://github.com/bbepis/Hayden

Anonymous

Search

FoolFuuka/Asagi

Fuuka Imageboard Archival Standard (Fuuka)

Asagi Imageboard Archival Standard (Asagi)

SQL Schema

Reference Implementation

New Implementation

Compilation and Usage

Asagi

FoolFuuka

How Asagi does stuff

Configuration

Misc

How Asagi decides to update a thread:

When Asagi does a thread update:

What does Asagi do with a post in a thread?

For OP:

For reply:

How Asagi handles an image in a thread?

How Asagi deals with post deletions?

How Asagi interacts with the database?

How each value is processed between 4ch and the DB

4ch → (Asagi) → DB

“poster_ip”

“no” - > “num”

“subnum”

“Thread_num”

“Time” ->“timestamp”

“resto” -> (If resto is 0, use value from “num”) -> op

N/A -> Preview_orig

“tn_w” -> “preview_w”

“tn_h” -> “preview_h”

N/A -> media_filename

“W” -> “media_w”

“h” -> “media_h”

“Media_size”

“Media_hash”

N/A -> “Media_orig”

“Spoiler”

N/A -> “Deleted”

“Capcode” -> “Capcode”

“email” -> “Email”

“Name” -> (cleanSimple()) -> “Name”

“trip” -> “Trip”

“sub” -> (cleanSimple()) -> “Title”

“com” -> (doClean) -> “Comment”

N/A -> “Delpass”

“sticky” -> “Sticky”

“closed”, “archived” -> “closed” AND (NOT “archived”)) -> “Locked”

“id” -> “Poster_hash”

“country” -> “Poster_country”

lots -> “exif”

Images table values:

4ch -> (Asagi) -> DB

N/A -> (Incremental integer) -> “media_id”

md5 -> (N/A) -> “media_hash”

N/A -> (Local filepath to full image) -> “media”

N/A -> (Local filepath to OP thumbnail) -> “preview_op”

N/A -> (Local filepath to reply thumbnail) -> “preview_reply”

N/A -> (incrementer) -> “total”

N/A -> (N/A) -> “banned”

Table definition

Image insert procedure

Data path:

4ch -> decode JSON -> make Post objects

Threads table values:

Files of note:

Functions of note:

SQL.java:

YoutsubaJSON.java:

Topic.java

References:

Navigation

Wiki tools

Page tools