Re: [PATCH] gnu: Add nethack.

[Kei Kebreau]

Chris Marusich  writes:

> Hi Kei,
>
> I felt the need to play a game, so I was looking into packaging Nethack.
> But I then found this email thread and saw that you already tried it!
> Inspired by the RPG theme, I decided to perform thread necromancy! :-)
>
> How did this pan out?  It looks like Nethack didn't wind up in the Guix
> git repo.  Was there a blocking issue?  The plan to create a ~/.nethack
> directory sounds like a good idea.
>

Creating the ~/.nethack directory does in fact work, but the last
NetHack patch in that thread messes with the user's home directory as
part of the installation process, which is forbidden for official Guix
packages. The correct fix for this would be to patch NetHack's source
code so that writing to files in the store (this is why I used the
~/.nethack directory workaround) would be unnecessary.

> Kei Kebreau  writes:
>
>> I haven't asked NetHack maintainers for advice yet. It seems like that
>> would be the next logical step, though.
>
> Did you ever talk with them about the issues you found?

I emailed them but never received a response.

P.S. I've been pondering on the patch for a while now, and IIRC Chris
Webber had a WIP angband patch on the mailing list as well. Help with
either package would be well appreciated! :-)


signature.asc
Description: PGP signature

Re: [PATCH] gnu: Add nethack.

[Leo Famulari]

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?

Re: [PATCH] gnu: Add nethack.

[Kei Kebreau]

On Wed, 08 Jun 2016 14:59:35 +0200
l...@gnu.org (Ludovic Courtès) wrote:

> Leo Famulari  skribis:
> 
> > On Mon, Jun 06, 2016 at 04:25:41PM -0400, Kei Kebreau wrote:  
> >> l...@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"?

-- 
Kei (GPG Key: 4096R/E6A5EE3C19467A0D)


pgpZYqQjOOdDt.pgp
Description: OpenPGP digital signature

Re: [PATCH] gnu: Add nethack.

[Ludovic Courtès]

Leo Famulari  skribis:

> On Mon, Jun 06, 2016 at 04:25:41PM -0400, Kei Kebreau wrote:
>> l...@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’.

Re: [PATCH] gnu: Add nethack.

[Leo Famulari]

On Mon, Jun 06, 2016 at 04:25:41PM -0400, Kei Kebreau wrote:
> l...@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.

Re: [PATCH] gnu: Add nethack.

[Kei Kebreau]

On Sat, 04 Jun 2016 23:15:57 +0200
l...@gnu.org (Ludovic Courtès) wrote:

> Hi!
> 
> Kei Kebreau <k...@openmailbox.org> skribis:
> 
> > From b728e078408f17136e8a4c3344b606e8f152b9e4 Mon Sep 17 00:00:00
> > 2001 From: Kei Kebreau <k...@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.h2016-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  

Re: [PATCH] gnu: Add nethack.

[Ludovic Courtès]

Hi!

Kei Kebreau <k...@openmailbox.org> skribis:

> From b728e078408f17136e8a4c3344b606e8f152b9e4 Mon Sep 17 00:00:00 2001
> From: Kei Kebreau <k...@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’.

[PATCH] gnu: Add nethack.

[Kei Kebreau]

NetHack finally works, though I'd like others to review the
implementation. This is also my first time adding a .patch file to the
repository, so advice along those lines would be appreciated.

-- 
Kei (GPG Key: 4096R/E6A5EE3C19467A0D)
From b728e078408f17136e8a4c3344b606e8f152b9e4 Mon Sep 17 00:00:00 2001
From: Kei Kebreau <k...@openmailbox.org>
Date: Tue, 31 May 2016 17:42:28 -0400
Subject: [PATCH] gnu: Add nethack.

* gnu/packages/games.scm (nethack): New variable.
---
 gnu/packages/games.scm | 98 ++
 ...thack-correct-directories-and-permissions.patch | 72 
 2 files changed, 170 insertions(+)
 create mode 100644 
gnu/packages/patches/nethack-correct-directories-and-permissions.patch

diff --git a/gnu/packages/games.scm b/gnu/packages/games.scm
index fc16862..44afb87 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,99 @@ 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
+   #: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"))
+ (("/bin/gzip") (which "gzip")))
+   (substitute* "sys/unix/setup.sh"
+ (("/bin/sh") (which "bash"
+ (system* "sh" "sys/unix/setup.sh" "sys/unix/hints/linux")))
+ (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")))
+ '("logfile" "perm" "record" "save" "xlogfile")
+ (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~%"
+ (assoc-ref inputs "bash") ;implicit input
+ (string-append nethack-user-dir)
+ (string-append nethack-user-dir)
+ (string-append
+  out "/games/lib/nethack-state-files")