emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: David Maus <dmaus@ictsoc.de>
To: nicholas.dokos@hp.com
Cc: David Maus <dmaus@ictsoc.de>,
	emacs-orgmode@gnu.org, bzg@altern.org,
	Carsten Dominik <carsten.dominik@gmail.com>
Subject: Re: [BUG] bug in org-publish and a (wrong) patch
Date: Mon, 27 Jun 2011 06:24:19 +0200	[thread overview]
Message-ID: <874o3bx5os.wl%dmaus@ictsoc.de> (raw)
In-Reply-To: <4871.1309147931@alphaville.dokosmarshall.org>


[-- Attachment #1.1: Type: text/plain, Size: 4484 bytes --]

At Mon, 27 Jun 2011 00:12:11 -0400,
Nick Dokos wrote:
>
> David Maus <dmaus@ictsoc.de> wrote:
>
> > At Fri, 08 Apr 2011 12:58:06 -0400,
> > Nick Dokos wrote:
> > >
> > > Carsten Dominik <carsten.dominik@gmail.com> wrote:
> > >
> > > > Hi Nick,
> > > >
> > > > I have not looked closely, but maybe you can use
> > > >
> > > >
> > > > (expand-file-name  .... (file-name-directory filename))
> > > >
> > > > to fix this patch?  Not sure, I have not spent any time on it.
> > > >
> > >
> > > Almost but not quite: C-h v expand-file-name says
> > >
> > > ,----
> > > | (expand-file-name NAME &optional DEFAULT-DIRECTORY)
> > > |
> > > | Convert filename NAME to absolute, and canonicalize it.
> > > | Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
> > > | (does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
> > > | the current buffer's value of `default-directory' is used.
> > > `----
> > >
> > > so you end up tacking it onto a completely unrelated directory (and my
> > > experiments confirm this).
> > >
> > > But there is a :base-directory for the project that could be obtained
> > > from the project-plist and passed to expand-file-name.  I think that
> > > would work but would require passing the project-plist down through a couple
> > > of layers to org-publish-cache-ctime-of-src. Alternatively, it (or just
> > > the base directory) could be bound dynamically in org-publish-file and
> > > used in the ctime function.
> > >
> > > What do you think would be preferable?
> >
> > Took some time, but attached patch fixes the problem w/o the need for
> > passing down :base-directory at all. Simply expand-filename only if
> > the symlink is relative; luckily the filename passed to this fun
> > already is absolute.
> >
> > @Bastien: Didn't push because I assume you already started the release
> > process for Org 7.6.
> >
>
> > From f6ed4d5707995f34a627886d0607dd7e6343144b Mon Sep 17 00:00:00 2001
> > From: David Maus <dmaus@ictsoc.de>
> > Date: Sun, 26 Jun 2011 20:02:42 +0200
> > Subject: [PATCH] Properly handle relative symlinks when publishing
> >
> > * org-publish.el (org-publish-cache-ctime-of-src): Properly handle
> > relative symlinks.
> >
> > At Thu, 07 Apr 2011 01:11:00 -0400,
> > Nick Dokos wrote:
> > >
> > > org-publish-cache-ctime-of-src tries (but does not always succeed) to
> > > deal with symlinks: file-symlink-p returns the target as a string, but
> > > if the target is relative to the symlink, that's not going to fly.
> > > e.g. if c is a symlink like this
> > >
> > >     /a/b/c->../d/f
> > >
> > > then (file-symlink-p "/a/b/c") -> "../d/f"
> > > but if the current directory is any place other than /a/b, the target
> > > will not be found, the file attributes are going to be nil and
> > > the function will blow up.
> > ---
> >  lisp/org-publish.el |    7 ++++---
> >  1 files changed, 4 insertions(+), 3 deletions(-)
> >
> > diff --git a/lisp/org-publish.el b/lisp/org-publish.el
> > index 56cc80a..0d3d70a 100644
> > --- a/lisp/org-publish.el
> > +++ b/lisp/org-publish.el
> > @@ -1157,9 +1157,10 @@ Returns value on success, else nil."
> >
> >  (defun org-publish-cache-ctime-of-src (filename)
> >    "Get the FILENAME ctime as an integer."
> > -  (let ((src-attr (file-attributes (if (stringp (file-symlink-p filename))
> > -				       (file-symlink-p filename)
> > -				     filename))))
> > +  (let* ((symlink-maybe (or (file-symlink-p filename) filename))
> > +	 (src-attr (file-attributes (if (file-name-absolute-p symlink-maybe)
> > +					symlink-maybe
> > +				      (expand-file-name symlink filename)))))
> >      (+
> >       (lsh (car (nth 5 src-attr)) 16)
> >       (cadr (nth 5 src-attr)))))
> > --
> > 1.7.2.5
> >
>
> I don't think it's correct as it stands: What is ``symlink'' on the last
> line?  should it be be symlink-maybe perhaps? and expand-file-name
> expands wrt to the default directory passed as its third argument. Maybe
> the third argument can be (file-name-directory filename) as Carsten
> suggested, but surely it cannot be just ``filename''.
>
> Replacing the last line with
>
>           (expand-file-name symlink-maybe (file-name-directory filename))...
>
> my (very simple) test case gets published correctly, so it's
> certainly better than what's there.

Damn, you are right. This patch was composed way to sloppy. Here's a
corrected one.

Best,
  -- David
--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #1.2: 0001-Properly-handle-relative-symlinks-when-publishing.patch --]
[-- Type: text/plain, Size: 1715 bytes --]

From 6ad9f33ccb2d8702dd1d4375dd82998f72078e60 Mon Sep 17 00:00:00 2001
From: David Maus <dmaus@ictsoc.de>
Date: Sun, 26 Jun 2011 20:02:42 +0200
Subject: [PATCH] Properly handle relative symlinks when publishing

* org-publish.el (org-publish-cache-ctime-of-src): Properly handle
relative symlinks.

At Thu, 07 Apr 2011 01:11:00 -0400,
Nick Dokos wrote:
>
> org-publish-cache-ctime-of-src tries (but does not always succeed) to
> deal with symlinks: file-symlink-p returns the target as a string, but
> if the target is relative to the symlink, that's not going to fly.
> e.g. if c is a symlink like this
>
>     /a/b/c->../d/f
>
> then (file-symlink-p "/a/b/c") -> "../d/f"
> but if the current directory is any place other than /a/b, the target
> will not be found, the file attributes are going to be nil and
> the function will blow up.
---
 lisp/org-publish.el |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/lisp/org-publish.el b/lisp/org-publish.el
index 56cc80a..5646430 100644
--- a/lisp/org-publish.el
+++ b/lisp/org-publish.el
@@ -1157,9 +1157,12 @@ Returns value on success, else nil."
 
 (defun org-publish-cache-ctime-of-src (filename)
   "Get the FILENAME ctime as an integer."
-  (let ((src-attr (file-attributes (if (stringp (file-symlink-p filename))
-				       (file-symlink-p filename)
-				     filename))))
+  (let* ((symlink-maybe (or (file-symlink-p filename) filename))
+	 (src-attr (file-attributes (if (file-name-absolute-p symlink-maybe)
+					symlink-maybe
+				      (expand-file-name 
+				       symlink-maybe
+				       (file-name-directory filename))))))
     (+
      (lsh (car (nth 5 src-attr)) 16)
      (cadr (nth 5 src-attr)))))
-- 
1.7.2.5


[-- Attachment #2: Type: application/pgp-signature, Size: 230 bytes --]

      reply	other threads:[~2011-06-27  4:37 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-04-07  5:11 [BUG] bug in org-publish and a (wrong) patch Nick Dokos
2011-04-07  5:37 ` Nick Dokos
2011-04-08 10:22 ` Carsten Dominik
2011-04-08 16:58   ` Nick Dokos
2011-06-26 18:10     ` David Maus
2011-06-27  4:12       ` Nick Dokos
2011-06-27  4:24         ` David Maus [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874o3bx5os.wl%dmaus@ictsoc.de \
    --to=dmaus@ictsoc.de \
    --cc=bzg@altern.org \
    --cc=carsten.dominik@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=nicholas.dokos@hp.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).