Honour existing restrictions if possible when visiting tasks from the agenda

Honour existing restrictions if possible when visiting tasks from the agenda

[Bernt Hansen]

The following short patch series fixes org file restriction
handling for me.  I'm regularly narrowing to subtrees for a
project from the agenda and then using the agenda to visit tasks
in the subtree.  Each time I visit a task, clock in, or
regenerate the agenda my restriction is removed in the org file.
The following patch series fixes this behaviour.

[PATCH 1/3] Honour existing restrictions when regenerating the agenda

[Bernt Hansen]

* lisp/org.el: Honour existing restrictions when regenerating the agenda

Narrowed org buffers are now retained when regenerating the agenda
with org-agenda-redo
---
 lisp/org.el |   14 +++++++-------
 1 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/lisp/org.el b/lisp/org.el
index 14b182b..75e6527 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -16431,13 +16431,13 @@ When a buffer is unmodified, it is just killed.  When modified, it is saved
 	(rea (concat ":" org-archive-tag ":"))
 	     bmp file re)
     (save-excursion
-      (save-restriction
-	(while (setq file (pop files))
-	  (catch 'nextfile
-	    (if (bufferp file)
-		(set-buffer file)
-	      (org-check-agenda-file file)
-	      (set-buffer (org-get-agenda-file-buffer file)))
+      (while (setq file (pop files))
+	(catch 'nextfile
+	  (if (bufferp file)
+	      (set-buffer file)
+	    (org-check-agenda-file file)
+	    (set-buffer (org-get-agenda-file-buffer file)))
+	  (save-restriction
 	    (widen)
 	    (setq bmp (buffer-modified-p))
 	    (org-refresh-category-properties)
-- 
1.7.8.247.g10f4e

[PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Bernt Hansen]

* lisp/org-agenda.el (org-agenda-clock-in): Save restriction when clocking in from the agenda

Narrowed org buffers are now retained when clocking in from the agenda.
We only widen the buffer when the task to clock in is outside the existing
restriction.
---
 lisp/org-agenda.el |   17 +++++++++--------
 1 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 780794e..f240f5e 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7797,14 +7797,15 @@ The cursor may be at a date in the calendar, or in the Org agenda."
 	   newhead)
       (org-with-remote-undo (marker-buffer marker)
         (with-current-buffer (marker-buffer marker)
-	  (widen)
-	  (goto-char pos)
-	  (org-show-context 'agenda)
-	  (org-show-entry)
-	  (org-cycle-hide-drawers 'children)
-	  (org-clock-in arg)
-	  (setq newhead (org-get-heading)))
-	(org-agenda-change-all-lines newhead hdmarker)))))
+	  (save-restriction
+	    (widen)
+	    (goto-char pos)
+	    (org-show-context 'agenda)
+	    (org-show-entry)
+	    (org-cycle-hide-drawers 'children)
+	    (org-clock-in arg)
+	    (setq newhead (org-get-heading)))
+	  (org-agenda-change-all-lines newhead hdmarker))))))
 
 (defun org-agenda-clock-out ()
   "Stop the currently running clock."
-- 
1.7.8.247.g10f4e

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Matt Lundin]

Hi Bernt,

Bernt Hansen <bernt@norang.ca> writes:

> * lisp/org-agenda.el (org-agenda-clock-in): Save restriction when clocking in from the agenda
>
> Narrowed org buffers are now retained when clocking in from the agenda.
> We only widen the buffer when the task to clock in is outside the existing
> restriction.

It seems that adding save-restriction to org-agenda-clock-in causes the
following:

When one clocks in from the agenda, all preexisting drawers in a buffer
are aligned to org-tags-column (i.e., the right side of the file).

I can confirm this using emacs -Q. 

Here's a sample file. Before clocking in it looks like this:

--8<---------------cut here---------------start------------->8---
* A headline
  SCHEDULED: <2012-01-18 Wed +1d>
  :LOGBOOK:
  CLOCK: [2012-01-18 Wed 20:10]--[2012-01-19 Thu 07:18] => 11:08
  :END:
  :PROPERTIES:
  :HELLO: there
  :END:
* And another
  :PROPERTIES:
  :NOW: and again
  :END:
--8<---------------cut here---------------end--------------->8---

After clocking in from the agenda -- (org-agenda-clock-in) -- the file
looks like this:

--8<---------------cut here---------------start------------->8---
* A headline
  SCHEDULED: <2012-01-18 Wed +1d>
                                                                       :LOGBOOK:
  CLOCK: [2012-01-19 Thu 07:19]
  CLOCK: [2012-01-18 Wed 20:10]--[2012-01-19 Thu 07:18] => 11:08
                                                                           :END:
                                                                    :PROPERTIES:
  :HELLO: there
                                                                           :END:
* And another
                                                                    :PROPERTIES:
  :NOW: and again
                                                                           :END:
--8<---------------cut here---------------end--------------->8---

Strangely (though not demonstrated in the above example), all tags in
the buffer are also realigned.

Note: org-indent-mode is not on. My emacs version is:

GNU Emacs 24.0.92.1 (i686-pc-linux-gnu, GTK+ Version 2.24.8) of
2012-01-18 on archeee

Org-version:

release_7.8.03-149-g46ff3
Org-mode version 7.8.03 (release_7.8.03.149.g46ff3)

Best, 
Matt

P.S. I hope all on the list are doing well. I look forward to
participating more in the near future.

Bernt Hansen <bernt@norang.ca> writes:

> * lisp/org-agenda.el (org-agenda-clock-in): Save restriction when clocking in from the agenda
>
> Narrowed org buffers are now retained when clocking in from the agenda.
> We only widen the buffer when the task to clock in is outside the existing
> restriction.
> ---
>  lisp/org-agenda.el |   17 +++++++++--------
>  1 files changed, 9 insertions(+), 8 deletions(-)
>
> diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
> index 780794e..f240f5e 100644
> --- a/lisp/org-agenda.el
> +++ b/lisp/org-agenda.el
> @@ -7797,14 +7797,15 @@ The cursor may be at a date in the calendar, or in the Org agenda."
>  	   newhead)
>        (org-with-remote-undo (marker-buffer marker)
>          (with-current-buffer (marker-buffer marker)
> -	  (widen)
> -	  (goto-char pos)
> -	  (org-show-context 'agenda)
> -	  (org-show-entry)
> -	  (org-cycle-hide-drawers 'children)
> -	  (org-clock-in arg)
> -	  (setq newhead (org-get-heading)))
> -	(org-agenda-change-all-lines newhead hdmarker)))))
> +	  (save-restriction
> +	    (widen)
> +	    (goto-char pos)
> +	    (org-show-context 'agenda)
> +	    (org-show-entry)
> +	    (org-cycle-hide-drawers 'children)
> +	    (org-clock-in arg)
> +	    (setq newhead (org-get-heading)))
> +	  (org-agenda-change-all-lines newhead hdmarker))))))
>  
>  (defun org-agenda-clock-out ()
>    "Stop the currently running clock."

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Bernt Hansen]

Eeek!

I'm not running into this (as far as I know) in my current setup but I
vote we just revert the clocking restriction patches.  There are other
unresolved issues with these patches that I've seen and don't currently
have a fix for.

  - column view clocking totals on the agenda are wrong if a restriction
    is in place in the org file

In my current setup recreating the restriction with a speed key is
easy so I can live with that until a proper fix can be created or we
decide to drop this patch series.

Bastien/Carsten:

Please revert the following commits (again).  Sorry :(

  - 7a73e15 (Remove file restrictions when generating clock report data, 2012-01-09)
  - e8f93a75 (Honour existing restrictions when visiting tasks from the agenda, 2011-12-30)
  - c41a6f5 (Honour existing restrictions when clocking in from the agenda, 2011-12-30)
  - a0a26cd (Honour existing restrictions when regenerating the agenda, 2011-12-30)

Regards,
Bernt

Matt Lundin <mdl@imapmail.org> writes:

> Hi Bernt,
>
> Bernt Hansen <bernt@norang.ca> writes:
>
>> * lisp/org-agenda.el (org-agenda-clock-in): Save restriction when clocking in from the agenda
>>
>> Narrowed org buffers are now retained when clocking in from the agenda.
>> We only widen the buffer when the task to clock in is outside the existing
>> restriction.
>
> It seems that adding save-restriction to org-agenda-clock-in causes the
> following:
>
> When one clocks in from the agenda, all preexisting drawers in a buffer
> are aligned to org-tags-column (i.e., the right side of the file).
>
> I can confirm this using emacs -Q. 
>
> Here's a sample file. Before clocking in it looks like this:
>
> * A headline
>   SCHEDULED: <2012-01-18 Wed +1d>
>   :LOGBOOK:
>   CLOCK: [2012-01-18 Wed 20:10]--[2012-01-19 Thu 07:18] => 11:08
>   :END:
>   :PROPERTIES:
>   :HELLO: there
>   :END:
> * And another
>   :PROPERTIES:
>   :NOW: and again
>   :END:
>
> After clocking in from the agenda -- (org-agenda-clock-in) -- the file
> looks like this:
>
> * A headline
>   SCHEDULED: <2012-01-18 Wed +1d>
>                                                                        :LOGBOOK:
>   CLOCK: [2012-01-19 Thu 07:19]
>   CLOCK: [2012-01-18 Wed 20:10]--[2012-01-19 Thu 07:18] => 11:08
>                                                                            :END:
>                                                                     :PROPERTIES:
>   :HELLO: there
>                                                                            :END:
> * And another
>                                                                     :PROPERTIES:
>   :NOW: and again
>                                                                            :END:
>
> Strangely (though not demonstrated in the above example), all tags in
> the buffer are also realigned.
>
> Note: org-indent-mode is not on. My emacs version is:
>
> GNU Emacs 24.0.92.1 (i686-pc-linux-gnu, GTK+ Version 2.24.8) of
> 2012-01-18 on archeee
>
> Org-version:
>
> release_7.8.03-149-g46ff3
> Org-mode version 7.8.03 (release_7.8.03.149.g46ff3)
>
> Best, 
> Matt
>
> P.S. I hope all on the list are doing well. I look forward to
> participating more in the near future.
>
> Bernt Hansen <bernt@norang.ca> writes:
>
>> * lisp/org-agenda.el (org-agenda-clock-in): Save restriction when clocking in from the agenda
>>
>> Narrowed org buffers are now retained when clocking in from the agenda.
>> We only widen the buffer when the task to clock in is outside the existing
>> restriction.
>> ---
>>  lisp/org-agenda.el |   17 +++++++++--------
>>  1 files changed, 9 insertions(+), 8 deletions(-)
>>
>> diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
>> index 780794e..f240f5e 100644
>> --- a/lisp/org-agenda.el
>> +++ b/lisp/org-agenda.el
>> @@ -7797,14 +7797,15 @@ The cursor may be at a date in the calendar, or in the Org agenda."
>>  	   newhead)
>>        (org-with-remote-undo (marker-buffer marker)
>>          (with-current-buffer (marker-buffer marker)
>> -	  (widen)
>> -	  (goto-char pos)
>> -	  (org-show-context 'agenda)
>> -	  (org-show-entry)
>> -	  (org-cycle-hide-drawers 'children)
>> -	  (org-clock-in arg)
>> -	  (setq newhead (org-get-heading)))
>> -	(org-agenda-change-all-lines newhead hdmarker)))))
>> +	  (save-restriction
>> +	    (widen)
>> +	    (goto-char pos)
>> +	    (org-show-context 'agenda)
>> +	    (org-show-entry)
>> +	    (org-cycle-hide-drawers 'children)
>> +	    (org-clock-in arg)
>> +	    (setq newhead (org-get-heading)))
>> +	  (org-agenda-change-all-lines newhead hdmarker))))))
>>  
>>  (defun org-agenda-clock-out ()
>>    "Stop the currently running clock."

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Bastien]

Hi Bernt and Matt,

Bernt Hansen <bernt@norang.ca> writes:

> Bastien/Carsten:
>
> Please revert the following commits (again).  Sorry :(

Done.  Thanks,

-- 
 Bastien

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Bernt Hansen]

Correction to the commit SHA1s

  - 7a73e15 (Remove file restrictions when generating clock report data, 2012-01-09)
  - 8f93a75 (Honour existing restrictions when visiting tasks from the agenda, 2011-12-30)
  - c41a6f5 (Honour existing restrictions when clocking in from the agenda, 2011-12-30)
  - a0a26cd (Honour existing restrictions when regenerating the agenda, 2011-12-30)

-Bernt

Bernt Hansen <bernt@norang.ca> writes:

> Please revert the following commits (again).  Sorry :(
>
>   - 7a73e15 (Remove file restrictions when generating clock report data, 2012-01-09)
>   - e8f93a75 (Honour existing restrictions when visiting tasks from the agenda, 2011-12-30)
>   - c41a6f5 (Honour existing restrictions when clocking in from the agenda, 2011-12-30)
>   - a0a26cd (Honour existing restrictions when regenerating the agenda, 2011-12-30)

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Sebastien Vauban]

Hi Bernt,

Bernt Hansen wrote:
> Eeek!
>
> I'm not running into this (as far as I know) in my current setup but I
> vote we just revert the clocking restriction patches.  There are other
> unresolved issues with these patches that I've seen and don't currently
> have a fix for.
>
> Please revert the following commits (again).  Sorry :(
>
>   - 7a73e15 (Remove file restrictions when generating clock report data, 2012-01-09)
>   - e8f93a75 (Honour existing restrictions when visiting tasks from the agenda, 2011-12-30)
>   - c41a6f5 (Honour existing restrictions when clocking in from the agenda, 2011-12-30)
>   - a0a26cd (Honour existing restrictions when regenerating the agenda, 2011-12-30)

FYI, I have the (subjective) impression that the below bug just came up a
couple of days ago. I would say less than one calendar week. But I may be
wrong.

>> After clocking in from the agenda -- (org-agenda-clock-in) -- the file
>> looks like this:
>>
>> * A headline
>>   SCHEDULED: <2012-01-18 Wed +1d>
>>                                                                        :LOGBOOK:
>>   CLOCK: [2012-01-19 Thu 07:19]
>>   CLOCK: [2012-01-18 Wed 20:10]--[2012-01-19 Thu 07:18] => 11:08
>>                                                                            :END:
>>                                                                     :PROPERTIES:
>>   :HELLO: there
>>                                                                            :END:
>> * And another
>>                                                                     :PROPERTIES:
>>   :NOW: and again
>>                                                                            :END:

Best regards,
  Seb

-- 
Sebastien Vauban

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Bastien]

"Sebastien Vauban" <wxhgmqzgwmuf@spammotel.com> writes:

> FYI, I have the (subjective) impression that the below bug just came up a
> couple of days ago. I would say less than one calendar week. But I may be
> wrong.

Same here. 

-- 
 Bastien

Re: [PATCH 2/3] Honour existing restrictions when clocking in from the agenda

[Bernt Hansen]

"Sebastien Vauban"
<wxhgmqzgwmuf-geNee64TY+gS+FvcfC7Uqw@public.gmane.org> writes:

> Hi Bernt,
>
> Bernt Hansen wrote:
>> Eeek!
>>
>> I'm not running into this (as far as I know) in my current setup but I
>> vote we just revert the clocking restriction patches.  There are other
>> unresolved issues with these patches that I've seen and don't currently
>> have a fix for.
>>
>> Please revert the following commits (again).  Sorry :(
>>
>>   - 7a73e15 (Remove file restrictions when generating clock report data, 2012-01-09)
>>   - e8f93a75 (Honour existing restrictions when visiting tasks from the agenda, 2011-12-30)
>>   - c41a6f5 (Honour existing restrictions when clocking in from the agenda, 2011-12-30)
>>   - a0a26cd (Honour existing restrictions when regenerating the agenda, 2011-12-30)
>
> FYI, I have the (subjective) impression that the below bug just came up a
> couple of days ago. I would say less than one calendar week. But I may be
> wrong.

Hi Seb,

These patches were created by me back in December and recently applied
by Bastien on Jan 11th so that's probably when the problem showed up.  I
saw the initial report about this alignment problem on the mailing list
when my gmane access came back but I couldn't reproduce it with my setup
(using org-indent-mode, but I didn't try very hard at the time) so I
just assumed incorrectly that this was caused by later commits I hadn't
pulled yet.

The 4 patches really all go in the same topic.  There are still other
problems with this series and right now I'm leaning towards dropping
them completely.  There are lots of places in the agenda where things
seem to go wrong if the org file restriction is retained.

Regards,
Bernt

[PATCH 3/3] Honour existing restrictions when visiting tasks from the agenda

[Bernt Hansen]

* lisp/org-agenda.el (org-agenda-switch-to): Widen org buffer only if point is
  outside the current restriction

Widen org buffer when visiting from agenda only if point is outside
current restriction.

Visiting a task with RET or TAB in the agenda should not affect the
org-mode buffer restriction unless the target task is not currently
visible due to the restriction.
---
 lisp/org-agenda.el |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index f240f5e..b009faf 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7033,7 +7033,9 @@ at the text of the entry itself."
 	   (pos (marker-position marker)))
       (org-pop-to-buffer-same-window buffer)
       (and delete-other-windows (delete-other-windows))
-      (widen)
+      (when (or (< pos (point-min))
+		(> pos (point-max)))
+	(widen))
       (goto-char pos)
       (when (eq major-mode 'org-mode)
 	(org-show-context 'agenda)
-- 
1.7.8.247.g10f4e

Re: Honour existing restrictions if possible when visiting tasks from the agenda

[Carsten Dominik]

Applied, thanks.

- Carsten

On 30.12.2011, at 11:49, Bernt Hansen wrote:

> The following short patch series fixes org file restriction
> handling for me.  I'm regularly narrowing to subtrees for a
> project from the agenda and then using the agenda to visit tasks
> in the subtree.  Each time I visit a task, clock in, or
> regenerate the agenda my restriction is removed in the org file.
> The following patch series fixes this behaviour.
> 

Re: Honour existing restrictions if possible when visiting tasks from the agenda

[Bernt Hansen]

Hi Carsten,

I think this patch series breaks agenda clock reports.  The total time
shown on the report only includes the data in the org file restrictions.

I don't have time to look at where to fix this yet so if it isn't easy
to fix maybe these patches should be temporarily reverted.

I'd been running with the patches for a week before I posted them but
didn't get to my weekly clock report review until today.

Regards,
Bernt


Carsten Dominik <carsten.dominik@gmail.com> writes:

> Applied, thanks.
>
> - Carsten
>
> On 30.12.2011, at 11:49, Bernt Hansen wrote:
>
>> The following short patch series fixes org file restriction
>> handling for me.  I'm regularly narrowing to subtrees for a
>> project from the agenda and then using the agenda to visit tasks
>> in the subtree.  Each time I visit a task, clock in, or
>> regenerate the agenda my restriction is removed in the org file.
>> The following patch series fixes this behaviour.
>>