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