GitHub - shlomif/fortune-mod: Implementation of the Unix fortune command for displaying a random quotation, for Linux and other systems. (original) (raw)

fortune-mod Maintenance Version and Ongoing Development

Travis-CI Build Status

AppVeyor Build status

This GitHub repository maintains the sources for fortune-mod, a version of the UNIX “fortune” command. fortune is a command-line utility which displays a random quotation from a collection of quotes. This collection is read from the local file system and does not require network access. A large collection of quotes is provided in the download and installed by default, but more quote collections can be added by the user.

The canonical repository for the time being is:https://github.com/shlomif/fortune-mod . In the future, we may create a GitHub organization for it, and move the sources there.

For more information about it, you can contactShlomi Fish .

Installation

On Fedora and other rpm-based distributions:

sudo dnf install fortune-mod

On Arch Linux and derivatives:

sudo pacman -S fortune-mod

On Alpine Linux:

curl -sL https://alpine.swee.codes/install.sh | doas sh # assumes you have doas and curl packages installed, and you aren't root doas apk add fortune-mod

On Debian, and derivatives (e.g: Ubuntu, Linux Mint):

curl -sL https://swee.codes/repo.sh | sudo bash sudo apt install fortune-mod-shlomif

If you are content with using a very old version, you can use:

sudo apt install fortune-mod

Building from Sources

See the INSTALL.asciidoc file. You might also wish to consult the GitHub Actions-based Continuous Integration procedures

Release Tarballs

One can find the official release tarballs of fortune-mod as prepared by CPack there. They have a proper containing directory. One can also download these tarballs from theGitHub releases page. However, please do not use the auto-generated “Source code (zip)” and “Source code (tar.gz)” downloads, which are both incomplete, and have extra directories inside.

Sample usage

$ fortune Enthusiasm is one of the most important ingredients a volunteer project runs on. -- Andreas Schuldei $

History

I believe fortune-mod was originally forked from the NetBSD version of fortune, and ported to run on Linux systems. For some time, it was maintained at the currently offline redellipse-dot-net inside aGNU Arch (= an old version control system) repository, and version 1.99.1 was released as a tarball.

This maintenance version was initiated by Shlomi Fish, who decided to maintain it, given he is a fan of the fortune command. It started by importing the unpacked source of the fortune-mod-1.99.1.tar tarball from the Mageia Linux .src.rpm into an empty git repository, and proceeding from there.

Why does running "fortune" fails?

There are several possible causes for that.

One of them is the fact that the “fortune” executable was placed in an unusual path, for example /usr/games/fortune rather than /usr/bin/fortune. If so, it sometimes need to be invoked using the full path.

What is the difference between fortune-mod and the "normal" fortune?

fortune-mod (= "fortune modified") was the name of a fork of the original NetBSD fortune, which was done in order to port the code to Linux and apply some other changes. If you are using a Linux distribution, chances are that the fortune executable’s package isfortune-mod (although in the case of Debian-and-derivatives it is likely very out-of-date as of September 2020).

Why is it written in C? Can’t it be written in Perl, awk, Python, etc.?

The answer has several parts:

First of all, note that according tothe wikipedia page, the original “fortune” was created in 1979. This is before the first version of perl was released in 1987, or those of python, ruby, or Lua, which were released later, and when UNIX-running computers were more underpowered than they are today.

Secondly, you can find some reimplementations of fortune here:

You may be able to get them to work with the data files of fortune-mod and other fortune collections, but note that we have not closely reviewed their source codes.

Thirdly, most of the value (and relative data size) of the tarball is in the quotes collection.

Fourthly, a native executable might still provide abetter user-experience. However, note that I have yet to perform a stresstest benchmark, and I doubt it will matter too much for “fortune”'s common use case.

Finally, note that fortune’s runtime algorithm is not as straightforward as one may believe, making use of “.dat” files that contain counts and offsets of the fortune “cookies”.

What was already done.

  1. fortune-mod-1.99.1 was imported into the repository from the Mageia tarball as the tag fortune-mod-1.99.1.
  2. Converted the build system toCMake .
  3. Converted the source files to UTF-8.
  4. Added some tests.
  5. Removed trailing whitespace.
  6. Reformatted long (> 80 chars) lines.
  7. Fixed some typos.
  8. Added Travis-CI testing.
  9. Added valgrind tests and fixed some memory leaks.
  10. Released fortune-mod-1.99.3, fortune-mod-1.99.4, v2.0.0 and up to version 2.26.0 and beyond.
  11. Fixed some C compiler warnings encountered with the GCC compiler flags ofShlomif_Common.
  12. Added a build-time option to remove the “-o” (= “offensive”) flag, inspired by a set of patches on the Fedora package.
  13. Applied some downstream patches.
  14. Fixed as many “clang -Weverything” warnings as possible.
  15. lib-recode became maintained again athttps://github.com/rrthomas/recode (thanks to @rrthomas ) thus preventing a switch to something else.
  16. Got the build and tests to pass onAppVeyor/MS Windows(with some appreciated help).
  17. Found and fixed some security issues:
  1. Reformatted the C code usingclang-format.
  2. Moved some cookies to/from the offensive collection.
  3. Added new cookies.

What remains to be done.

  1. Fix more typos (issue reports and pull-requests are welcome.)
  2. Add more quotes / fortune cookies (issue reports and pull-requests are welcome.).
  3. Prepare packages for the new releases fordownstream distributions/Operating Systems.