Source code of manned.org https://manned.org/
Find a file
Yorhel 83ab6c3671 Get rid of package categories
Whether or not the package name itself or the (category,name) tuple
uniquely identified a package within a system has been a source of
confusion for a long time. Back in
03d278e4ff I ended up playing playing it
"safe" by going for (category,name), but in practice this doesn't make a
whole lot of sense. While it's *possible* for the same package name to
refer to completely different packages in different "categories", in
reality distributions can't sanely support this anyway.

For distributions where the category referred to a repository, the only
cases where the same package name was used in different repos was when
the package has moved from one repo to another. Those should certainly
not be treated as different packages.

For distributions where the category really referred to a category,
there's the Debian approach where the category is purely a tag and
doesn't help identify the package in any way, and then there's FreeBSD
where the category technically ought to be part of the name.  There were
a few cases where FreeBSD used categories to separate out different
versions of the same package (e.g. ipv6 vs non-ipv6), but none were
relevant for man pages so I ended up merging those as well.

Getting rid of the categories simplifies and shortens URLs, unclutters
the UI a little bit and merges the packages in listings that should've
been merged all along.

Migration script:

  -- Merge packages that are in multiple categories.
  -- All versions are moved to the package with the lowest ID.
  -- If the same version already exists in a lower ID, the higher-ID version is deleted.
  BEGIN;
  WITH migrate(old, new, second) AS (
    SELECT q.id, MIN(p.id), MAX(p.id)
      FROM packages p
      JOIN packages q ON q.id > p.id AND p.system = q.system AND p.name = q.name
     GROUP BY q.id
  ), ded(n) AS (
    UPDATE packages SET dead = false
      FROM migrate m
      JOIN packages q ON q.id = m.old
     WHERE packages.id = m.new AND packages.dead AND NOT q.dead
    RETURNING 1
  ), mov(n) AS (
    UPDATE package_versions SET package = m.new
      FROM migrate m
     WHERE package_versions.package = m.old
       AND NOT EXISTS(
          SELECT 1
            FROM package_versions v
           WHERE v.package IN(m.new, m.second)
             AND v.version = package_versions.version)
    RETURNING 1
  ), del(n) AS (
    DELETE FROM packages WHERE id IN(SELECT old FROM migrate)
    RETURNING 1
  ) SELECT (SELECT count(*) FROM migrate) AS migrate,
           (SELECT count(*) FROM ded) AS ded,
           (SELECT count(*) FROM mov) AS mov,
           (SELECT count(*) FROM del) AS del;

  ALTER TABLE packages DROP CONSTRAINT packages_system_name_category_key;
  CREATE UNIQUE INDEX packages_system_name_key ON packages (system, name);
  ALTER TABLE packages DROP COLUMN category;
  COMMIT;
2024-04-28 10:37:04 +02:00
indexer Get rid of package categories 2024-04-28 10:37:04 +02:00
lib/ManUtils Add Ubuntu 21.10 2021-10-17 09:56:28 +02:00
util Get rid of package categories 2024-04-28 10:37:04 +02:00
web Make the Rust garbage compile again 2021-12-11 11:53:26 +01:00
www Get rid of package categories 2024-04-28 10:37:04 +02:00
.gitignore Index NetBSD 2024-04-14 11:35:04 +02:00
COPYING Switch to AGPL license 2021-12-13 17:56:29 +01:00
Makefile A few more HTML conversion improvements 2017-01-15 20:27:16 +01:00
README.md Make the Rust garbage compile again 2021-12-11 11:53:26 +01:00
schema.sql Get rid of package categories 2024-04-28 10:37:04 +02:00

The Manned.org Source Code

This repository holds the source code of Manned.org. For a description of the site, check out https://manned.org/info/about.

Ironically, documentation about how things work is completely lacking.

Requirements

  • perl: A somewhat recent version (no idea which, due to my XS usage)
  • postgresql: Also a somewhat recent version
  • rust: Version who-knows-which

Web front-end

  • AnyEvent
  • DBD::Pg
  • DBI
  • JSON::XS
  • SQL::Interp
  • TUWF

Man page indexer

  • curl
  • psql

File structure

  • indexer/ -> The Rust program that scans package repositories for updates, fetches new packages and extracts the man pages.
  • lib/ManUtils/ -> Perl/XS helper module to format man pages into HTML (uses web/).
  • sql/ -> Database schema & updates.
  • util/ -> Cron job and scripts to run indexer/ on the right repositories.
  • web/ -> Badly named Rust library to convert man pages into HTML.
  • www/ -> The web front-end.