diff mbox

gnu: Add nethack.

Message ID 20160606162541.5254ed6c@openmailbox.org
State New
Headers show

Commit Message

Kei Yamashita June 6, 2016, 8:25 p.m. UTC
On Sat, 04 Jun 2016 23:15:57 +0200
ludo@gnu.org (Ludovic Courtès) wrote:

> Hi!
> 
> Kei Kebreau <kei@openmailbox.org> skribis:
> 
> > From b728e078408f17136e8a4c3344b606e8f152b9e4 Mon Sep 17 00:00:00
> > 2001 From: Kei Kebreau <kei@openmailbox.org>
> > Date: Tue, 31 May 2016 17:42:28 -0400
> > Subject: [PATCH] gnu: Add nethack.
> >
> > * gnu/packages/games.scm (nethack): New variable.  
> 
> You need to mention the new .patch file here (see ‘git log’ for
> examples.)
> 
> You also need to add the .patch file to gnu/local.mk, and to mention
> the change to gnu/local.mk in the commit log.
> 
> [...]
> 
> > +         (replace 'configure
> > +           (lambda* (#:key inputs outputs #:allow-other-keys)
> > +             (let ((out (assoc-ref outputs "out")))
> > +               (substitute* "sys/unix/hints/linux"
> > +                 (("^PREFIX=.*$")
> > +                  (string-append "PREFIX=" out "\n"))
> > +                 (("/bin/gzip") (which "gzip")))
> > +               (substitute* "sys/unix/setup.sh"
> > +                 (("/bin/sh") (which "bash"))))
> > +             (system* "sh" "sys/unix/setup.sh"
> > "sys/unix/hints/linux")))  
> 
> Should be: (zero? (system* …)), which returns #t on success (a phase
> must return a true value to be considered successful.)
> 
> > +         (add-after 'install 'move-state-files
> > +           (lambda* (#:key inputs outputs #:allow-other-keys)
> > +             (let* ((out (assoc-ref outputs "out")))
> > +               (mkdir (string-append out
> > "/games/lib/nethack-state-files"))
> > +               (chdir (string-append out "/games/lib/nethackdir"))
> > +               (for-each (lambda (file)
> > +                           (system* "mv" file
> > +                                    (string-append
> > +                                     out
> > "/games/lib/nethack-state-files")))  
> 
> Instead of using the ‘mv’ command (or any other Coreutils command, for
> that matter), use the Scheme equivalent.  Here it would be:
> 
>   (install-file file directory)
> 
> Besides, “/games” is unusual in the file system hierarchy.  Usually,
> state files go to the localstatedir, i.e., the var/PACKAGE
> subdirectory.
> 
> Thus, what about putting state files in OUT/var/nethack?
> 
> But again, OUT is immutable, so these files cannot be modified, so
> they’re not really “state.”
> 
> > +                         '("logfile" "perm" "record" "save"
> > "xlogfile")))))  
> 
> For clarity, have the phase return #t.
> 
> > +         (add-after 'move-state-files 'wrap-program
> > +           (lambda* (#:key inputs outputs #:allow-other-keys)
> > +             (let* ((out (assoc-ref outputs "out"))
> > +                    (bin (string-append out "/bin"))
> > +                    (nethack-user-dir "~/.nethack"))
> > +               (mkdir bin)
> > +               (with-directory-excursion bin
> > +                 (call-with-output-file "nethack"
> > +                   (lambda (port)
> > +                     (format port "#!~a/bin/sh -e
> > +# Create NetHack directory in user's $HOME if it isn't there
> > +if [ ! -d ~a ]; then
> > +  mkdir -p ~a
> > +  cp -r ~a/* ~a
> > +  chmod -R +w ~a
> > +fi
> > +
> > +RUNDIR=$(mktemp -d)
> > +
> > +cleanup() {
> > +  rm -rf $RUNDIR
> > +}
> > +trap cleanup EXIT
> > +
> > +cd $RUNDIR
> > +for i in ~a/*; do
> > +  ln -s $i $(basename $i)
> > +done
> > +for i in ~a/*; do
> > +  ln -s $i $(basename $i)
> > +done
> > +./nethack~%"  
> 
> Do we really need this wrapper?  Can’t we instead take it as a patch
> from Debian or something?  I’m not a fan of inline Bash code, and not
> very confident of scripts that do ‘rm -rf’.  :-)
> 
> 
> > +--- nethack-3.6.0.orig/include/config.h	2016-05-27
> > 17:20:03.062318307 -0400 ++++ nethack-3.6.0/include/config.h
> > 2016-05-31 16:48:04.283642766 -0400  
> 
> Patches must always start with a line or two indicating what they do
> and what their upstream status or origin is.
> 
> > +@@ -308,7 +308,6 @@
> > + #define INSURANCE /* allow crashed game recovery */
> > + 
> > + #ifndef MAC
> > +-#define CHDIR /* delete if no chdir() available */
> > + #endif  
> 
> Why?
> 
> > +-# CC = gcc
> > ++CC = gcc
> > + #
> > + #	For Bull DPX/2 systems at B.O.S. 2.0 or higher use the
> > following:
> > + #
> > +@@ -104,11 +104,11 @@
> > + 
> > + # yacc/lex programs to use to generate *_comp.h, *_lex.c, and
> > *_yacc.c.
> > + # if, instead of yacc/lex you have bison/flex, comment/uncomment
> > the following. +-YACC     = yacc
> > +-LEX      = lex
> > +-# YACC     = bison -y
> > ++# YACC     = yacc
> > ++# LEX      = lex
> > ++YACC     = bison -y
> > + # YACC     = byacc
> > +-# LEX      = flex
> > ++LEX      = flex  
> 
> Would it work to, instead, do:
> 
>   #:make-flags '("CC=gcc" "LEX=flex" …)
> 
> If it does, I think it’s preferable.
> 
> Could you send an updated patch?
> 
> Thanks for working on this tricky package!  ;-)
> 
> Ludo’.

Unfortunately, Debian doesn't have any related patches because it's
state files are writable in the equivalent of our store directories. It
seems like the bash script will have to stay for the sake of
functionality unless someone comes up with something cleaner, though I
prefer to avoid them. Long ago, I lost a GNU/Linux installation to
"rm -rf"...

I've added comments to the patch file and replaced the calls to
coreutils with their Scheme equivalent (and cleaned up nethack's store
folder along the way).

Comments

Leo Famulari June 7, 2016, 5:20 p.m. UTC | #1
On Mon, Jun 06, 2016 at 04:25:41PM -0400, Kei Kebreau wrote:
> ludo@gnu.org (Ludovic Courtès) wrote:
> > > +         (add-after 'move-state-files 'wrap-program
> > 
> > Do we really need this wrapper?  Can’t we instead take it as a patch
> > from Debian or something?  I’m not a fan of inline Bash code, and not
> > very confident of scripts that do ‘rm -rf’.  :-)
> > 
> Unfortunately, Debian doesn't have any related patches because it's
> state files are writable in the equivalent of our store directories. It
> seems like the bash script will have to stay for the sake of
> functionality unless someone comes up with something cleaner, though I
> prefer to avoid them. Long ago, I lost a GNU/Linux installation to
> "rm -rf"...

If Nethack lacks the ability to configure the location of the state
files, there is still a string (or several) in the source code that
looks like '/usr/share/nethack'. I think we should change this string to
something more appropriate instead of wrapping Nethack.
Ludovic Courtès June 8, 2016, 12:59 p.m. UTC | #2
Leo Famulari <leo@famulari.name> skribis:

> On Mon, Jun 06, 2016 at 04:25:41PM -0400, Kei Kebreau wrote:
>> ludo@gnu.org (Ludovic Courtès) wrote:
>> > > +         (add-after 'move-state-files 'wrap-program
>> > 
>> > Do we really need this wrapper?  Can’t we instead take it as a patch
>> > from Debian or something?  I’m not a fan of inline Bash code, and not
>> > very confident of scripts that do ‘rm -rf’.  :-)
>> > 
>> Unfortunately, Debian doesn't have any related patches because it's
>> state files are writable in the equivalent of our store directories. It
>> seems like the bash script will have to stay for the sake of
>> functionality unless someone comes up with something cleaner, though I
>> prefer to avoid them. Long ago, I lost a GNU/Linux installation to
>> "rm -rf"...
>
> If Nethack lacks the ability to configure the location of the state
> files, there is still a string (or several) in the source code that
> looks like '/usr/share/nethack'. I think we should change this string to
> something more appropriate instead of wrapping Nethack.

Yeah, I would also prefer something along these lines.

What do you think, Kei?  Does that sound doable?

Thanks,
Ludo’.
Kei Yamashita June 8, 2016, 6:05 p.m. UTC | #3
On Wed, 08 Jun 2016 14:59:35 +0200
ludo@gnu.org (Ludovic Courtès) wrote:

> Leo Famulari <leo@famulari.name> skribis:
> 
> > On Mon, Jun 06, 2016 at 04:25:41PM -0400, Kei Kebreau wrote:  
> >> ludo@gnu.org (Ludovic Courtès) wrote:  
> >> > > +         (add-after 'move-state-files 'wrap-program  
> >> > 
> >> > Do we really need this wrapper?  Can’t we instead take it as a
> >> > patch from Debian or something?  I’m not a fan of inline Bash
> >> > code, and not very confident of scripts that do ‘rm -rf’.  :-)
> >> >   
> >> Unfortunately, Debian doesn't have any related patches because it's
> >> state files are writable in the equivalent of our store
> >> directories. It seems like the bash script will have to stay for
> >> the sake of functionality unless someone comes up with something
> >> cleaner, though I prefer to avoid them. Long ago, I lost a
> >> GNU/Linux installation to "rm -rf"...  
> >
> > If Nethack lacks the ability to configure the location of the state
> > files, there is still a string (or several) in the source code that
> > looks like '/usr/share/nethack'. I think we should change this
> > string to something more appropriate instead of wrapping Nethack.  
> 
> Yeah, I would also prefer something along these lines.
> 
> What do you think, Kei?  Does that sound doable?
> 
> Thanks,
> Ludo’.

I'm not so sure. Is there a way that I can explicitly access the
home directory of the user that invokes guix? That is, something
clearer than "~/.nethack"?
Leo Famulari June 8, 2016, 8:44 p.m. UTC | #4
On Wed, Jun 08, 2016 at 02:05:32PM -0400, Kei Kebreau wrote:
> I'm not so sure. Is there a way that I can explicitly access the
> home directory of the user that invokes guix? That is, something
> clearer than "~/.nethack"?

Do we have any package definitions that write to '/home/$USER'? I would
rather we didn't do that as a side effect of installing the package.

It's really the responsibility of the packaged software to set this up
when the user first runs it. If it can't, the user can copy the
"template" state files from '/gnu/store/...-nethack/whatever' into their
home directory.

Have you asked the NetHack maintainers for advice?
Kei Yamashita June 9, 2016, 1:17 a.m. UTC | #5
On Wed, 8 Jun 2016 16:44:36 -0400
Leo Famulari <leo@famulari.name> wrote:

> On Wed, Jun 08, 2016 at 02:05:32PM -0400, Kei Kebreau wrote:
> > I'm not so sure. Is there a way that I can explicitly access the
> > home directory of the user that invokes guix? That is, something
> > clearer than "~/.nethack"?  
> 
> Do we have any package definitions that write to '/home/$USER'? I
> would rather we didn't do that as a side effect of installing the
> package.
>

I haven't seen any packages definitions that do that in my casual
browsing the source tree. I wouldn't want to do that either, but it is
the only way I can come up with to get NetHack working while
minimally changing how it works. Doing more than this may require
patches in NetHack's C code, but I'm not familiar with the code base.

> It's really the responsibility of the packaged software to set this up
> when the user first runs it. If it can't, the user can copy the
> "template" state files from '/gnu/store/...-nethack/whatever' into
> their home directory.
>
> Have you asked the NetHack maintainers for advice?

I haven't asked NetHack maintainers for advice yet. It seems like that
would be the next logical step, though.
diff mbox

Patch

diff --git a/gnu/local.mk b/gnu/local.mk
index c130901..c9facb9 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -636,6 +636,7 @@  dist_patch_DATA =						\
   gnu/packages/patches/mutt-store-references.patch		\
   gnu/packages/patches/net-tools-bitrot.patch			\
   gnu/packages/patches/netcdf-config-date.patch			\
+  gnu/packages/patches/nethack-correct-directories-and-permissions.patch \
   gnu/packages/patches/ngircd-handle-zombies.patch		\
   gnu/packages/patches/ngircd-no-dns-in-tests.patch		\
   gnu/packages/patches/ninja-tests.patch			\
diff --git a/gnu/packages/games.scm b/gnu/packages/games.scm
index fc16862..43aa9e5 100644
--- a/gnu/packages/games.scm
+++ b/gnu/packages/games.scm
@@ -49,10 +49,12 @@ 
   #:use-module (gnu packages autotools)
   #:use-module (gnu packages backup)
   #:use-module (gnu packages base)
+  #:use-module (gnu packages bison)
   #:use-module (gnu packages admin)
   #:use-module (gnu packages audio)
   #:use-module (gnu packages avahi)
   #:use-module (gnu packages boost)
+  #:use-module (gnu packages flex)
   #:use-module (gnu packages fribidi)
   #:use-module (gnu packages game-development)
   #:use-module (gnu packages gettext)
@@ -2243,3 +2245,112 @@  Red Eclipse provides fast paced and accessible gameplay.")
                      license:cc-by-sa3.0
                      license:cc-by3.0
                      license:cc0)))))
+
+(define-public nethack
+  (package
+    (name "nethack")
+    (version "3.6.0")
+    (source (origin
+              (method url-fetch)
+              (uri (string-append "mirror://sourceforge/" name "/" name "-"
+                                  (string-join (string-split version #\.) "")
+                                  "-src.tgz"))
+              (sha256
+               (base32
+                "12mi5kgqw3q029y57pkg3gnp930p7yvlqi118xxdif2qhj6nkphs"))
+              (patches
+               (search-patches
+                "nethack-correct-directories-and-permissions.patch"))))
+    (build-system gnu-build-system)
+    (arguments
+     `(#:tests? #f ; no check target
+       #:make-flags '("CC=gcc" "LEX=flex" "YACC=bison -y")
+       #:phases
+       (modify-phases %standard-phases
+         (replace 'configure
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (let ((out (assoc-ref outputs "out")))
+               (substitute* "sys/unix/hints/linux"
+                 (("^PREFIX=.*$")
+                  (string-append "PREFIX=" out "\n"))
+                 (("^HACKDIR=.*$")
+                  (string-append "HACKDIR=" out "/var/hackdir\n"))
+                 (("^SHELLDIR=.*$")
+                  (string-append "SHELLDIR=" out "/var\n"))
+                 (("/bin/gzip") (which "gzip")))
+               (substitute* "sys/unix/setup.sh"
+                 (("/bin/sh") (which "bash"))))
+             (zero? (system* "sh" "sys/unix/setup.sh" "sys/unix/hints/linux"))))
+         (add-after 'install 'post-install
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (let* ((out (assoc-ref outputs "out")))
+               (mkdir-p (string-append out "/var/nethack/save"))
+               (chdir (string-append out "/var/hackdir"))
+               (delete-file-recursively "save")
+
+               ; unnecessary script, the one wrapped below runs fine
+               (delete-file-recursively (string-append out "/games"))
+               (install-file "recover" (string-append out "/bin"))
+               (delete-file "recover")
+               (for-each (lambda (file)
+                           (install-file file
+                                         (string-append
+                                          out
+                                          "/var/nethack"))
+                           (delete-file file))
+                         '("logfile" "perm" "record" "xlogfile"))
+             #t)))
+         (add-after 'post-install 'wrap-program
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (let* ((out (assoc-ref outputs "out"))
+                    (bin (string-append out "/bin"))
+                    (nethack-user-dir "~/.nethack"))
+               (with-directory-excursion bin
+                 (call-with-output-file "nethack"
+                   (lambda (port)
+                     (format port "#!~a/bin/sh -e
+# Create NetHack directory in user's $HOME if it isn't there
+if [ ! -d ~a ]; then
+  mkdir -p ~a
+  cp -r ~a/* ~a
+  chmod -R +w ~a
+fi
+
+RUNDIR=$(mktemp -d)
+
+cleanup() {
+  rm -rf $RUNDIR
+}
+trap cleanup EXIT
+
+cd $RUNDIR
+for i in ~a/*; do
+  ln -s $i $(basename $i)
+done
+for i in ~a/*; do
+  ln -s $i $(basename $i)
+done
+./nethack~%"
+                             (assoc-ref inputs "bash") ;implicit input
+                             (string-append nethack-user-dir)
+                             (string-append nethack-user-dir)
+                             (string-append
+                              out "/var/nethack")
+                             (string-append nethack-user-dir)
+                             (string-append nethack-user-dir)
+                             (string-append nethack-user-dir)
+                             (string-append out "/var/hackdir")
+                             (string-append out))))
+                 (chmod "nethack" #o555)))
+             #t)))))
+    (native-inputs
+     `(("bison" ,bison)
+       ("flex" ,flex)))
+    (inputs `(("ncurses" ,ncurses)))
+    (home-page "http://nethack.org")
+    (synopsis "Single player dungeon exploration game")
+    (description
+     "Nethack is a roguelike game that emphasizes discovery of details in the
+dungeon.  The random number generator provides an unlimited number of
+variations of the dungeon.")
+    (license (license:fsf-free "http://nethack.org/common/license.html"))))
diff --git a/gnu/packages/patches/nethack-correct-directories-and-permissions.patch b/gnu/packages/patches/nethack-correct-directories-and-permissions.patch
new file mode 100644
index 0000000..9154712
--- /dev/null
+++ b/gnu/packages/patches/nethack-correct-directories-and-permissions.patch
@@ -0,0 +1,40 @@ 
+Patch by Kei Kebreau <kei@openmailbox.org>
+Keeping "#define CHDIR" makes NetHack unable to find its scoreboard record.
+The other two modifications enable building on Linux and building with the
+ncurses library, respectively.
+
+diff -r -u nethack-3.6.0.orig/include/config.h nethack-3.6.0/include/config.h
+--- nethack-3.6.0.orig/include/config.h	2016-05-27 17:20:03.062318307 -0400
++++ nethack-3.6.0/include/config.h	2016-05-31 16:48:04.283642766 -0400
+@@ -308,7 +308,6 @@
+ #define INSURANCE /* allow crashed game recovery */
+ 
+ #ifndef MAC
+-#define CHDIR /* delete if no chdir() available */
+ #endif
+ 
+ #ifdef CHDIR
+diff -r -u nethack-3.6.0.orig/include/unixconf.h nethack-3.6.0/include/unixconf.h
+--- nethack-3.6.0.orig/include/unixconf.h	2016-05-27 17:20:03.062318307 -0400
++++ nethack-3.6.0/include/unixconf.h	2016-05-30 20:33:52.132273630 -0400
+@@ -36,7 +36,7 @@
+ #define NETWORK        /* if running on a networked system */
+                        /* e.g. Suns sharing a playground through NFS */
+ /* #define SUNOS4 */   /* SunOS 4.x */
+-/* #define LINUX */    /* Another Unix clone */
++#define LINUX          /* Another Unix clone */
+ /* #define CYGWIN32 */ /* Unix on Win32 -- use with case sensitive defines */
+ /* #define GENIX */    /* Yet Another Unix Clone */
+ /* #define HISX */     /* Bull Unix for XPS Machines */
+diff -r -u nethack-3.6.0.orig/sys/unix/Makefile.src nethack-3.6.0/sys/unix/Makefile.src
+--- nethack-3.6.0.orig/sys/unix/Makefile.src	2016-05-27 17:20:03.082318966 -0400
++++ nethack-3.6.0/sys/unix/Makefile.src	2016-06-05 12:30:33.301505514 -0400
+@@ -238,7 +238,7 @@
+ # WINTTYLIB = -ltermcap
+ # WINTTYLIB = -lcurses
+ # WINTTYLIB = -lcurses16
+-# WINTTYLIB = -lncurses
++WINTTYLIB = -lncurses
+ #WINTTYLIB = -ltermlib
+ #
+ # libraries for X11