chiark / gitweb /
A batch of copyright date updates.
[disorder] / CHANGES.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
2 <html>
3 <head>
4 <title>DisOrder Change History</title>
5 <link rel=StyleSheet type="text/css" href="docs.css">
6 </head>
7
8 <body>
9 <h1>DisOrder Change History</h1>
10
11 <p>This file documents recent user-visible changes to <a
12  href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>.</p>
13
14 <p><b>IMPORTANT</b>: you should read <a
15 href="README.upgrades.html">README.upgrades</a> before upgrading.</p>
16
17 <h2>Changes up to version 5.1</h2>
18
19 <div class=section>
20
21   <h3>Removable Device Support</h3>
22
23   <div class=section>
24
25     <p>The server will now automatically initiate a rescan when a filesystem is
26     mounted or unmounted.  (Use the <tt>mount_rescan</tt> option if you want to
27     suppress this behavior.)</p>
28
29     <p>The server takes care not to hold audio files open unnecessarily, so
30     that devices can be unmounted even if tracks from them are currently being
31     buffered.</p>
32
33   </div>
34
35   <h3>Disobedience</h3>
36
37   <div class=section>
38
39     <p>You can now edit the <tt>required-tags</tt> and <tt>prohibited-tags</tt>
40     global preferences in Disobedience
41     (<a href="http://code.google.com/p/disorder/issues/detail?id=29">issue
42     #29</a>).</p>
43
44     <p>The &ldquo;Manage users&rdquo; option is now more reliably greyed out if
45     it will not work.  This depends on a server change too, so it may still be
46     wrong if a new Disobedience is used against an old server.</p>
47
48   </div>
49
50   <h3>Backups</h3>
51
52   <div class=section>
53
54     <p>The Debian package now includes a cronjob that backs up the database
55     daily.  See <tt>/etc/cron.d/disorder</tt>.  You can put settings
56     in <tt>/etc/default/disorder</tt> to turn this off or to control how long
57     the backups are kept for.</p>
58
59     <p>The <tt>disorder-dump -r</tt> option was broken.</p>
60
61     <p><tt>disorder-dump</tt> now gets permissions right automatically (<a
62     href="http://code.google.com/p/disorder/issues/detail?id=56">issue
63     #56</a>).</p>
64
65   </div>
66
67   <h3>General</h3>
68
69   <div class=section>
70
71     <p>Unicode support has been upgraded to <a
72     href="http://www.unicode.org/versions/Unicode6.0.0/">Unicode
73     6.0.0</a>.</p>
74
75     <p>Client programs no longer depend on libdb.</p>
76     
77     <p>The following have been removed:</p>
78
79     <ul>
80
81       <li>The <tt>allow</tt>, <tt>gap</tt>, <tt>lock</tt>, <tt>prefsync</tt>, 
82       <tt>restrict</tt>, <tt>trust</tt> configuration commands.  If they still
83       appear in your configuration file then the server will not start.</li>
84
85       <li>The <tt>columns</tt> web interface option.  It will generate an
86       message in your error log but otherwise be ignored.</li>
87
88       <li>The <tt>--wait-for-device</tt> player option.  If it still appears in
89       any player commands, they will not work.</li>
90
91       <li>Support for automatically importing pre-3.0 users.</li>
92
93     </ul>
94
95     <p>Various minor bug fixes.</p>
96
97   </div>
98
99 </div>
100
101 <h2>Changes up to version 5.0.3</h2>
102
103 <div class=section>
104
105 <p><b>Security</b>: Local connections can no longer create and delete users
106 unless they are properly authorized.</p>
107
108 </div>
109
110 <h2>Changes up to version 5.0.2</h2>
111
112 <div class=section>
113
114 <p>The login form now indicates that a cookie will be set.</p>
115
116 </div>
117
118 <h2>Changes up to version 5.0.1</h2>
119
120 <div class=section>
121
122 <h3>Disobedience</h3>
123
124 <div class=section>
125
126 <p>The sense of the Control &#x2192; Playing menu item was fixed.</p>
127
128 </div>
129
130 </div>
131
132 <h2>Changes up to version 5.0</h2>
133
134   <div class=section>
135   
136     <h3>Server</h3>
137  
138     <div class=section>
139
140       <p>The <tt>device</tt> configuration option now works under OS X.
141       Devices may
142       be specified either by UID or name.  Fixes <a
143        href="http://code.google.com/p/disorder/issues/detail?id=27">Issue
144       27</a>.</p>
145
146       <p>Gapless play should be more reliable, and playback latency over RTP
147       should be a bit lower.  Note though that all the sound output code has
148       been reorganized and in some cases completely rewritten, so it's possible
149       that bugs may have been (re-)introduced.  Decoding of scratches is also
150       initiated ahead of time, giving more reliable playback.</p>
151       
152       <p>The <tt>command</tt> backend now (optionally) sends silence instead
153       of suspending writes when a pause occurs or no track is playing.</p>
154
155       <p>If <a href="http://www.mega-nerd.com/SRC/">libsamplerate</a> is
156       available at build time then that will be used instead of invoking
157       <a href="http://sox.sourceforge.net/">SoX</a>.  SoX support will be
158       removed in a future version.</p>
159
160       <p>The libao plugin has been removed, because the plugin API is not
161       usable in libao 1.0.0.</p>
162
163       <p>Playlists are now supported.  These allow a collection of tracks to be
164       prepared offline and played as a unit.</p>
165
166     </div>
167       
168     <h3>Disobedience</h3>
169
170     <div class=section>
171
172       <p>Multiple tracks can now be dragged in the queue in a single operation.
173       Furthermore, it is now possible to drag tracks from the
174       &ldquo;Recent&rdquo;, &ldquo;Added&rdquo; and &ldquo;Choose&rdquo; tabs
175       to the queue.</p>
176
177       <p>Disobedience now supports playlist editing and has a compact mode,
178       available from the <b>Control</b> menu.</p>
179
180       <p>Disobedience has a <a href="disobedience/manual/index.html">new
181       manual</a>.</p>
182
183     </div>
184
185     <h3>Web Interface</h3>
186  
187     <div class=section>
188
189       <p>Confirmation URLs should be cleaner (and in particular not end
190       with punctuation).  (Please see <a
191       href="README.upgrades.html">README.upgrades</a> for more about this.)</p>
192
193     </div>
194       
195     <h3>RTP Player</h3>
196   
197     <div class=section>
198
199       <p>There is a new <tt>--command</tt> option which allows the RTP player
200       to send audio data to a user-chosen command instead of an audio API. See
201       the man page for details.</p>
202       
203       <p>The <tt>--device</tt> option to <tt>disorder-playrtp</tt> now works
204       under OS X (as above).</p>
205         
206     </div>
207       
208     <h3>General</h3>
209
210     <div class=section>
211
212       <p>IPv6 should now work.  Network address specifications
213       (<tt>listen</tt>, <tt>connect</tt> etc) can now be prefixed with
214       <tt>-4</tt> or <tt>-6</tt> to force use
215       of IPv4 or IPv6, though normally this should not be needed.</p>
216
217       <p>Unicode support has been upgraded to <a
218       href="http://www.unicode.org/versions/Unicode5.1.0/">Unicode
219       5.1.0</a>.</p>
220
221       <p>Various elements of the source code have been
222       rationalized.</p>
223       
224     </div>
225     
226     <h3>Bugs fixed</h3>
227   
228     <div class=section>
229
230       <table class=bugs>
231         <tr>
232           <th>ID</th>
233           <th>Description</th>
234         </tr>
235
236         <tr>
237           <td><a href="http://code.google.com/p/disorder/issues/detail?id=22">#22</a></td>
238           <td>Background decoders interact badly with server reload</td>
239         </tr>
240
241         <tr>
242           <td><a href="http://code.google.com/p/disorder/issues/detail?id=27">#27</a></td>
243           <td>Mac DisOrder uses wrong sound device</td>
244         </tr>
245
246         <tr>
247           <td><a href="http://code.google.com/p/disorder/issues/detail?id=30">#30</a></td>
248           <td>mini disobedience interface</td>
249         </tr>
250
251         <tr>
252           <td><a href="http://code.google.com/p/disorder/issues/detail?id=32">#32</a></td>
253           <td>Excessively verbose log chatter on shutdown</td>
254         </tr>
255
256         <tr>
257           <td><a href="http://code.google.com/p/disorder/issues/detail?id=33">#33</a></td>
258           <td>(Some) plugins need -lm.</td>
259         </tr>
260
261         <tr>
262           <td><a href="http://code.google.com/p/disorder/issues/detail?id=39">#39</a></td>
263           <td>Double bind() non-multicast AF_INET</td>
264         </tr>
265
266         <tr>
267           <td><a href="http://code.google.com/p/disorder/issues/detail?id=40">#40</a></td>
268           <td>Missing stub function</td>
269         </tr>
270
271         <tr>
272           <td><a href="http://code.google.com/p/disorder/issues/detail?id=41">#41</a></td>
273           <td>Missing includes for timeval</td>
274         </tr>
275
276         <tr>
277           <td><a href="http://code.google.com/p/disorder/issues/detail?id=42">#42</a></td>
278           <td>syntax error in empeg_host section</td>
279         </tr>
280
281         <tr>
282           <td><a href="http://code.google.com/p/disorder/issues/detail?id=43">#43</a></td>
283           <td>decoder segfault with FLAC 1.2.1</td>
284         </tr>
285
286         <tr>
287           <td><a href="http://code.google.com/p/disorder/issues/detail?id=44">#44</a></td>
288           <td>gcc 4.3.2-1ubuntu12 SUYB patch</td>
289         </tr>
290
291         <tr>
292           <td><a href="http://code.google.com/p/disorder/issues/detail?id=45">#45</a></td>
293           <td>disobedience doesn't configure its back end</td>
294         </tr>
295
296         <tr>
297           <td><a href="http://code.google.com/p/disorder/issues/detail?id=46">#46</a></td>
298           <td>Sort search results in web interface</td>
299         </tr>
300
301         <tr>
302           <td><a href="http://code.google.com/p/disorder/issues/detail?id=48">#48</a></td>
303           <td>build-time dependency on <tt>oggdec</tt> removed</td>
304         </tr>
305
306         <tr>
307           <td><a href="http://code.google.com/p/disorder/issues/detail?id=49">#49</a></td>
308           <td>Disobedience's 'When' column gets out of date</td>
309         </tr>
310
311         <tr>
312           <td><a href="http://code.google.com/p/disorder/issues/detail?id=51">#51</a></td>
313           <td>Improved speaker process robustness</td>
314         </tr>
315
316         <tr>
317           <td>(none)</td>
318           <td>&ldquo;found track in no collection&rdquo; messages for scratches
319           are now suppressed</td>
320         </tr>
321
322         <tr>
323           <td>(none)</td>
324           <td>Disobedience would sometimes fail to notice when a track
325           started, leading to its display getting out of date.</td>
326         </tr>
327
328       </table>
329     </div>
330   </div>
331
332 <h2>Changes up to version 4.3</h2>
333
334   <div class=section>
335
336     <h3>Disobedience</h3>
337
338       <div class=section>
339
340         <p>A bug was fixed in the calculation of how much of the track had
341         played.  This would lead to the counter showing incorrect values in
342         various situations.</p>
343
344         <p>Disobedience's icons have been changed to larger, more colorful
345         ones.  The SVG source is included if you want to fiddle with them.</p>
346
347         <p>&ldquo;Select all&rdquo; is now no longer available in the choose
348         tab.  Instead there is a new &ldquo;Select children&rdquo; option which
349         selects the file children of a single subdirectory.</p>
350
351       </div>
352
353     <h3>Server</h3>
354
355       <div class=section>
356
357         <p>The selection bias for newly added tracks was reduced by half.  You
358         can put it back to the old very neophilic value with
359         &ldquo;<tt>new_bias 900000</tt>&rdquo; in the config file.</p>
360
361         <p>It is now possible to &lsquo;adopt&rsquo; randomly picked tracks.
362         Disobedience and the command-line client support this but the web
363         interface does not.</p>
364
365         <p>The default track name parsing was modified to handle filenames
366         generated by iTunes.</p>
367         
368       </div>
369
370     <h3>Miscellaneous</h3>
371
372       <div class=section>
373
374         <p><tt>disorderfm</tt> now preserves directory permissions.</p>
375
376         <p>DisOrder is now licensed under <a
377          href="http://www.gnu.org/licenses/gpl-3.0.html">GPL v3</a>.  The main
378         goal is to prohibit <a
379          href="http://en.wikipedia.org/wiki/Tivoization">Tivoization</a>.</p>
380
381         <p>The build system will now automatically cope with Fink's broken GTK+
382         packages.  There are a number of improvements to the Debian
383         packaging.</p>
384
385         <p>DisOrder now builds on 64-bit Linux systems.</p>
386
387         <p>There are various minor fixes.</p>
388
389       </div>
390
391   <h3>Bugs fixed</h3>
392   
393     <div class=section>
394
395       <table class=bugs>
396         <tr>
397           <th>ID</th>
398           <th>Description</th>
399         </tr>
400         
401         <tr>
402           <td><a href="http://code.google.com/p/disorder/issues/detail?id=24">#24</a></td>
403           <td>Fails to build on ubuntu 8.10</td>
404         </tr>
405         <tr>
406           <td><a href="http://code.google.com/p/disorder/issues/detail?id=26">#26</a></td>
407           <td>Disobedience shows wrong track elapsed time after a pause</td>
408         </tr>
409       </table>
410       
411     </div>
412   </div>
413
414 <h2>Changes up to version 4.2</h2>
415
416 <div class=section>
417
418   <h3>Disobedience</h3>
419   
420     <div class=section>
421
422       <p>The login window now has a 'remote' switch.  If this is turned off
423       then Disobedience will connect to a local server.  Formerly it would
424       always use TCP/IP.</p>
425
426       <p>The Delete and backspace keys will now remove tracks from the queue.
427       Escape will now dismiss the properties, users or login windows and return
428       now works in the login and properties windows.</p>
429       
430     </div>
431
432   <h3>Documentation</h3>
433   
434     <div class=section>
435
436       <p>Track and global preferences are now described in a new
437       <b>disorder_preferences</b>(5) man page.</p>
438       
439     </div>
440
441   <h3>Bugs fixed</h3>
442   
443     <div class=section>
444
445       <table class=bugs>
446         <tr>
447           <th>ID</th>
448           <th>Description</th>
449         </tr>
450         
451         <tr>
452           <td><a href="http://code.google.com/p/disorder/issues/detail?id=21">#21</a></td>
453           <td>CGI should use PATH_INFO more sensibly</td>
454         </tr>
455       </table>
456       
457     </div>
458 </div>
459
460
461 <h2>Changes up to version 4.1.1</h2>
462
463 <div class=section>
464
465   <p>Disobedience's &ldquo;Login&rdquo; window now works when you are logged
466   in.</p>
467   
468 </div>
469
470 <h2>Changes up to version 4.1</h2>
471
472 <div class=section>
473
474   <h3>Disobedience</h3>
475   
476     <div class=section>
477   
478       <p>Disobedience has been largely rewritten:</p>
479
480       <ul>
481         
482         <li>All the tabs now use native GTK+ list/tree widgets, resulting in
483         greater speed in some cases and more consistency with other GTK+
484         applications.</li>
485
486         <li>You can now use type-ahead find in the choose tab.  The initiation
487         of a search is delayed slightly to avoid lots of updates when you're
488         half way through entering search terms.</li>
489
490         <li>The choose tab now shows track lengths.</li>
491     
492         <li>Many buttons are now more reliably made insensitive when they can't
493         be used.</li>
494
495         <li>You can now play tracks off the recent tab.</li>
496         
497       </ul>
498       
499       <p>Disobedience attempts to cope with servers from older versions, up to
500       a point, but this is not well tested and it's best to keep the server
501       fully up to date.</p>
502
503     </div>
504      
505   <h3>Server</h3>
506   
507     <div class=section>
508
509       <p>When a track shares a directory with its alias, the real track name is
510       now returned instead of the alias (the opposite way round to the previous
511       behaviour).</p>
512       
513     </div>
514 </div>
515
516 <h2>Changes up to version 4.0.2</h2>
517
518 <div class=section>
519
520   <p>Corrected web browser linked from Disobedience.</p>
521   
522 </div>
523
524 <h2>Changes up to version 4.0.1</h2>
525
526 <div class=section>
527
528   <p>Libtool and Automake now install the CGI correctly.  As part of this,
529   <tt>cgidir</tt> has been renamed to <tt>cgiexecdir</tt>.  The configure
530   script will report an error if you try to use the old name.</p>
531   
532 </div>
533
534 <h2>Changes up to version 4.0</h2>
535
536 <div class=section>
537
538   <h3>Server</h3>
539
540 <div class=section>
541   
542   <p>The <tt>gap</tt> directive will no longer work.  It could be
543   restored if there is real demand.</p>
544   
545   <h4>Event Scheduling</h4>
546
547 <div class=section>
548
549   <p>It is now possible to schedule events to occur in the future.
550   Currently the supported actions are playing a specific track, and
551   changing a global preference (thus allowing e.g. random play to be
552   turned on or off).  See the <tt>schedule-*</tt>
553   commands described in disorder(1).</p>
554
555 </div>
556
557 <h4>Random Track Choice</h4>
558
559 <div class=section>
560
561   <p>This has been completely rewritten to support new features:</p>
562
563   <ul>
564
565     <li>tracks in the recently-played list or in the queue are no longer
566     eligible for random choice.</li>
567
568     <li>there is a new <tt>weight</tt> track preference allowing for
569     non-uniform track selection.  See disorder(1) for details.</li>
570
571     <li>there is a new configuration item <tt>replay_min</tt> defining
572     the minimum time before a played track can be picked at random.
573     The default is 8 hours (which matches the earlier behaviour).</li>
574
575     <li>recently added tracks are biased up; see <tt>new_bias</tt> and
576     <tt>new_bias_age</tt> in disorder_config(5).</li>
577
578   </ul>
579
580 </div>
581
582 <h4>Web Interface</h4>
583
584 <div class=section>
585
586   <p>This has been largely rewritten.  The most immediate benefits are:</p>
587
588   <ul>
589     
590     <li>the search page is integrated into the choose page, and
591     includes links to parent directories.</li>
592     
593     <li>if you try to do something you have insufficient rights for,
594     instead of getting an error page or nothing happening, you are
595     redirected to the login page.</li>
596
597   </ul>
598
599   <p>Customizers should find their lives easier: the syntax is less onerous, it
600   is possible to define macros to avoid repetition, and the documentation is
601   less monolithic (see disorder.cgi(8) as a starting point).</p>
602
603   <p>Mail is now sent via the system sendmail program, though it remains
604   possible to use TCP to connect to an SMTP server.  See <tt>sendmail</tt> and
605   <tt>smtp_server</tt> in disorder_config(5).</p>
606
607   <p>The web interface is now installed automatically.  If you don't want it,
608   use <tt>./configure --without-cgi</tt>.  If you want it in a non-default
609   location, or no location for it is detected, set <tt>cgidir</tt>
610   and <tt>httpdir</tt> on the <tt>./configure</tt> command line.</p>
611   
612 </div>
613
614 </div>
615
616 <h3>Disobedience</h3>
617
618 <div class=section>
619
620   <p>There is now a new user management window.  From here you can add and
621   remove users or modify their settings.</p>
622
623   <p>Relatedly, the server will only allow remote user management if you set
624   <tt>remote_userman</tt> to <tt>yes</tt>.</p>
625
626 </div>
627
628 <h3>Miscellaneous</h3>
629
630 <div class=section>
631
632   <p><tt>scripts/setup</tt> now honors command line options, and can
633   set up network play as well as the local default sound device.</p>
634
635 </div>
636
637 <h3>Bugs Fixed</h3>
638
639 <div class=section>
640
641   <table class=bugs>
642     <tr>
643       <th>ID</th>
644       <th>Description</th>
645     </tr>
646
647     <tr>
648       <td><a href="http://code.google.com/p/disorder/issues/detail?id=2">#2</a></td>
649       <td>Search results should link to directories</td>
650     </tr>
651
652     <tr>
653       <td><a href="http://code.google.com/p/disorder/issues/detail?id=6">#6</a></td>
654       <td>Schedule tracks for a particular time</td>
655     </tr>
656
657     <tr>
658       <td><a href="http://code.google.com/p/disorder/issues/detail?id=10">#10</a></td>
659       <td>Non-uniform track selection</td>
660     </tr>
661
662     <tr>
663       <td><a href="http://code.google.com/p/disorder/issues/detail?id=11">#11</a></td>
664       <td>Bias random selection to newly added tracks</td>
665     </tr>
666
667     <tr>
668       <td><a href="http://code.google.com/p/disorder/issues/detail?id=13">#13</a></td>
669       <td>Default encoding for debian setup scripts</td>
670     </tr>
671
672     <tr>
673       <td><a href="http://code.google.com/p/disorder/issues/detail?id=16">#16</a></td>
674       <td>Cookie expiry causes user to be silently logged out and not
675       subsequently redirected to login page</td>
676     </tr>
677     
678     <tr>
679       <td><a href="http://code.google.com/p/disorder/issues/detail?id=20">#20</a></td>
680       <td>Broken aliasing rules</td>
681     </tr>
682     
683   </table>
684
685 </div>
686
687 </div>
688
689 <h2>Changes up to version 3.0.2</h2>
690
691 <div class=section>
692
693   <p>Builds <tt>--without-server</tt> should work again.</p>
694
695   <p>The web interface is a bit more liberal in the cookie value
696   syntax it will accept.</p>
697
698   <p>Clients fail more gracefully if no password is available.</p>
699
700 </div>
701
702 <h2>Changes up to version 3.0.1</h2>
703
704 <div class=section>
705   
706   <p>Debian upgrades from 2.0.x should now work better.</p>
707   
708 </div>
709
710 <h2>Changes up to version 3.0</h2>
711
712 <div class=section>
713   
714   <p><b>Important</b>!  See <a
715   href="README.upgrades.html">README.upgrades</a> when upgrading.</p>
716   
717   <h3>Platforms And Installation</h3>
718   
719 <div class=section>
720   
721   <p>Mac OS X and FreeBSD are somewhat supported.  There is now a bash
722   script in <tt>scripts/setup</tt> which will automate the setup after
723   <tt>make install</tt>.</p>
724   
725 </div>
726
727 <h3>Server</h3>
728
729 <div class=section>
730   
731   <p>Users are now stored in the database rather than a configuration
732   file.</p>
733   
734   <p>The server now has a built-in list of stopwords and players, so
735   only additions to these need be mentioned in the configuration file.</p>
736   
737   <p>The default inter-track gap is now 0s.</p>
738   
739   <p>How sound is played is now controlled via the new <tt>api</tt>
740   configuration command.  This also controls how the volume is set,
741   which now works with ALSA as well as OSS.</p>
742   
743   <p>A bug in the MP3 decoder was fixed (also in 2.0.4).</p>
744   
745 </div>
746
747 <h3>Web Interface</h3>
748
749 <div class=section>
750   
751   <p>The web interface now uses cookies to remember user identity, and
752   allows online registration of new users.  Also it is no longer
753   necessary to manually specify the URL of the web interface (but you
754   can override it if you don't like the value it figures out).</p>
755   
756   <p>It is possible to allow users to register via the web interface.</p>
757   
758   <p>The web interface's browser support has been improved.  It has
759   been tested with Firefox 2, Safari 3, Konqueror 3, Internet Explorer
760   7 and Opera 9.</p>
761   
762 </div>
763
764 <h3>Disobedience</h3>
765
766 <div class=section>
767
768   <p>A bug which would cause a crash if you attempt to rearrange the
769   queue while no track was playing has been fixed.  There is a new
770   'deselect all tracks' option, mirroring 'select all tracks.</p>
771   
772 </div>
773
774 </div>
775
776 <!--
777 Local Variables:
778 fill-column:79
779 indent-tabs-mode:nil
780 End:
781 -->