chiark / gitweb /
CHANGES and docs updates for user management window
[disorder] / CHANGES
1 * Changes up to version 3.1
2
3 ** Server
4
5 The 'gap' directive will no longer work.  It could be restored if there
6 is real demand.
7
8 *** Random Track Choice
9
10 This has been completely rewritten to support new features:
11    - tracks in the recently-played list or in the queue are no longer
12      eligible for random choice
13    - there is a new 'weight' track preference allowing for non-uniform
14      track selection.  See disorder(1) for details.
15    - there is a new configuration item replay_min defining the minimum
16      time before a played track can be picked at random.  The default is
17      8 hours (which matches the earlier behaviour).
18
19 ** Disobedience
20
21 There is now a new user management window.  From here you can add and
22 remove users or modify their settings.
23
24 * Changes up to version 3.0
25
26 Important!  See README.upgrades when upgrading.
27
28 ** Platforms And Installation
29
30 Mac OS X and FreeBSD are somewhat supported.  There is now a bash script
31 in scripts/setup which will automate the setup after 'make install'.
32
33 ** Server
34
35 Users are now stored in the database rather than a configuration file.
36
37 The server now has a built-in list of stopwords and players, so only
38 additions to these need be mentioned in the configuration file.
39
40 The default inter-track gap is now 0s.
41
42 How sound is played is now controlled via the new 'api' configuration
43 command.  This also controls how the volume is set, which now works with
44 ALSA as well as OSS.
45
46 A bug in the MP3 decoder was fixed (also in 2.0.4).
47
48 ** Web Interface
49
50 The web interface now uses cookies to remember user identity, and allows
51 online registration of new users.  Also it is no longer necessary to
52 manually specify the URL of the web interface (but you can override it
53 if you don't like the value it figures out).
54
55 It is possible to allow users to register via the web interface.
56
57 The web interface's browser support has been improved.  It has been
58 tested with Firefox 2, Safari 3, Konqueror 3, Internet Explorer 7 and
59 Opera 9.
60
61 ** Disobedience
62
63 A bug which would cause a crash if you attempt to rearrange the queue
64 while no track was playing has been fixed.  There is a new 'deselect all
65 tracks' option, mirroring 'select all tracks.
66
67 * Changes up to version 2.0
68
69 ** General
70
71 Tracks can now have tags associated with them.  See tags in disorder(1)
72 or the preferences documentation for the web interface or Disobedience.
73
74 The search facility knows how to limit results by tag (see search
75 documentation for any interface) as well as by word search.  It is
76 possible to limit random play by tag (see required-tags and
77 prohibited-tags in disorder_config(5)).
78
79 Unicode support is improved.  Case-folding and word breaking now follows
80 the rules given in the Unicode standard (with a bit of tailoring in the
81 latter case).
82
83 ** Disobedience
84
85 There is a new client, 'Disobedience', that depends on the GTK+ library.
86 Feedback on the interface would be very welcome.
87
88 ** Web Interface
89
90 The "New" screen display tracks recently added to the database.  From
91 here they can be played or their preferences changed.
92
93 Long track names are truncated so they fit better on the screen.  Hover
94 for the full name.
95
96 ** Network Play
97
98 DisOrder can broadcast audio over a network, allowing it to be played on
99 multiple client machines.  See README.streams for details.
100
101 ** Server
102
103 Slow file lookups are cached in the server.  This should help
104 installations with large collections and/or slow platforms.
105
106 The 'enabled' and 'random_enabled' configuration options are now gone.
107 Instead the state survives from one run of the server to the next.
108 'disable now' is gone as well - if you want to emulate it disable
109 playing and then scratch the current track.
110
111 The 'pick' plugin has been abolished.  All the logic formerly done there
112 is now built into the server, where it can be done much more
113 efficiently.
114
115 'tracklength' plugins must be explicitly specified.
116
117 A bug where removing a collection (from the configuration) could cause a
118 crash when random play was enabled has been fixed.
119
120 A new configuration option 'queue_pad' allows the number of random
121 tracks kept on the queue to be controlled.
122
123 There is a new utility disorder-decode which can decode OGG, MP3, WAV
124 and FLAC.  The example config file uses it.
125
126 Database statistics are computed in a subprocess so that the main server
127 (and all clients) are not blocked for the duration.
128
129 ** disorderfm
130
131 There is a new command line tool called 'disorderfm' which is designed
132 for filename translation on (for instance) digital audio repositories.
133 It is not yet feature-complete.  See its man page for additional
134 details.
135
136 ** Build And Configuration
137
138 You can control which components are built with new --with options.  See
139 README.
140
141 options.transform and the 'transform' web option have gone, replaced
142 with a 'transform' configuration command.  Both this and 'namepart' are
143 now optional.
144
145 ** Thanks
146
147 Ross Younger, Colin Watson, Michael Stevens and Mark Wooding all
148 contributed in some way to this release.
149
150 * Changes up to version 1.5.1
151
152 ** Web Interface
153
154 Correct regexp for non-alpha tracks.
155
156 * Changes up to version 1.5
157
158 ** Web Interface
159
160 Regexp-based filtering of tracks (for instance as used by the initial
161 'Choose' page) now does the regexp matching in the server, limiting the
162 amount of data transferred to the web interface only to be discarded.
163
164 ** Client
165
166 Regexp-base filtering of tracks is now available to the command line
167 client.
168
169 ** Server
170
171 New server_nice, speaker_nice and rescan_nice configuration options
172 allow independent control of process priorities.
173
174 Scratches are now attributed to the user who requested them.
175
176 Bugs fixed:
177   A file descriptor was leaked for each track played.
178   The amount of a track played so far was not reported.
179   The speaker process could crash on underrun.
180   The server would crash if you paused a non-pause capable track.
181   Regexp matching in the file and directory list commands was not
182   reliable.
183   Handling of variable-argument commands in the client was broken.
184
185 * Changes up to version 1.4
186
187 ** General
188
189 Raw format players are now supported.  See README.upgrades and
190 README.raw for details.  This allows pausing and eliminating the
191 inter-track gap.
192
193 Pausing is also supported with suitably modified standalone player
194 plugins, though none of the supplied ones are capable of this.
195
196 When random play is enabled the randomly picked track now appears in the
197 queue, and can be moved around the queue, removed from it, etc.
198
199 ** Web Interface
200
201 Switches (random play, pause, ...) are now presented as a
202 fixed-appearance switch with an adjacent state indicator.
203
204 The 'Manage' screen has new buttons to move tracks to the head or tail
205 of the queue.
206
207 You can now edit the preferences for all the tracks in an album in a
208 single screen, rather than having to visit each separately.  For the
209 time being the raw preferences editing has gone; it can be reintroduced
210 on some form if there is demand.  (You can still edit raw preferences
211 from the command line.)
212
213 Labels are now documented in options.labels rather than
214 disorder_config(5).
215
216 ** Server
217
218 If you tried to start up on any empty database with random play enabled
219 the server would exit with an error.
220
221 The server no longer risks failing if you strace its player
222 subprocesses.
223
224 It was possible for the server to hang when a 'reconfigure' command was
225 issued.  This should no longer be the case.
226
227 The default signal to forcibly terminate players is now SIGKILL.
228
229 ** Plugins
230
231 Plugins must now declare a type word.  This allows them to document
232 whether they are a standalone player or a raw-format player, and whether
233 they support pausing.  They can also arrange to get setup and cleanup
234 calls in the main server.  See disorder(3) for more details.
235
236 * Changes up to version 1.3
237
238 ** Dependencies
239
240 Berkeley DB 4.2 is no longer supported.  Use 4.3.
241
242 ** Client
243
244 There is a new 'authorize' command to simplify the addition of local
245 users.  Please report successes as well as failures.
246
247 There is a new 'resolve' command to return the real track name behind an
248 alias.
249
250 The 'rescan' command no longer takes an argument.
251
252 ** Server
253
254 The track database code has been largely rewritten to improve
255 maintainability.
256
257 There is a new 'lock' directive.  By default the server uses a lockfile
258 to prevent multiple copies of itself running simultaneously; this can be
259 inhibited e.g. if you are using a filesystem that does not support
260 locking and are confident you can prevent concurrent running yourself.
261
262 Aliases for track names, constructed from trackname_display_
263 preferences, now appear in the virtual filesystem.  
264
265 The server now executes a subprocess for the rescan operation.  It also
266 runs a separate deadlock manager.
267
268 Standard output and standard error from subprocesses are now logged.
269 This is handy if you need to figure out why a player failed unexpectedly
270 but might lead to huge log files if you have needlessly verbose players.
271
272 ** Web Interface
273
274 Enable/disable buttons are now colored to reflect current state.
275
276 Entering numeric volume values (rather than clicking on the arrows) now
277 works.
278
279 Connection errors are reported more gracefully.
280
281 ** Plugins
282
283 Scanner plugins are now always invoked in a subprocess.
284
285 disorder_track_count() and disorder_track_getn() are no longer
286 available.  Instead use disorder_track_random().
287
288 Plugins are now opened with RTLD_NOW, so link errors are detected
289 immediately.
290
291 ** Tools
292
293 disorder-dump now insists on the input/output file being a named regular
294 file, rather than using stdin or stdout.
295
296 ** Other
297
298 Some missing files have been added, and some notes added regarding
299 getting text encoding right.
300
301 * Changes up to version 1.2
302
303 See README.upgrades when upgrading to this version.
304
305 ** Bugs Fixed
306
307 Avoid accumulating overlarge recently played list.
308
309 When the server was stopped, the currently playing track would not be
310 added to the recently played list.  This has been fixed.
311
312 Reloading the 'volume' page no longer repeats the last volume-changing
313 action.
314
315 The search facility now works properly for multiple hits within a single
316 artist or album.
317
318 ** Server
319
320 New namepart directive replaces web interface's trackname-part.  There
321 are associated changes to the protocol and clients.
322
323 The number of database queries per candidate match required when
324 searching has been reduced.
325
326 The operator can control the signal used to scratch playing tracks.  The
327 default has been changed to SIGINT from SIGKILL.
328
329 The 'log' command now provides a formalised event log, rather than raw
330 access to the server's ordinary log output.
331
332 ** Web Interface Changes
333
334 *** Choosing Tracks
335
336 When picking a track the client now stays on the same screen rather than
337 redirecting back to the 'Playing' screen.  So that the user gets
338 feedback from their action, playing and queued tracks are now marked as
339 such in the track picking screen.
340
341 It is possible to revert to the old behaviour by removing the back=
342 argument from the choose.html and search.html templates (and optionally
343 the trackstate lines).
344
345 *** Search
346
347 Non-ASCII characters are now properly supported in search terms.
348
349 *** Syntax
350
351 The template syntax has been changed slightly to ignore whitespace in
352 certain places.
353
354 *** Miscellaneous
355
356 Some formerly textual buttons are now replaced by images (with ALT text
357 reflecting the old value).  The stylesheet is now a .css file (installed
358 in the same place as the images) rather than being embedded into every
359 template.
360
361 Artist and album names in the playing and recently-played lists are now
362 links to the corresponding directory.
363
364 More functions are now available from the 'manage' screen.
365
366 The menus are now (by default) across the top of the screen instead of
367 down the side.  Set the 'menu' label to 'sidebar' to restore the old
368 appearance.  'Volume' is not present in this new menu, use 'Manage'
369 instead (or edit the template).
370
371 ** tkdisorder
372
373 tkdisorder now displays artist, album and title in the queue and
374 recently played widgets, rather than just the title (as formerly).
375
376 * Changes up to version 1.1
377
378 ** Bugs Fixed
379
380 Corrected various problems with UTF-8 parsing.
381
382 In the web interface, "The Beatles" (etc) are now grouped under 'B' not
383 'T' when grouping tracks by initial letter.
384
385 ** Server
386
387 The list of recently played tracks is now preserved across server
388 restarts.
389
390 Track IDs are more compact.
391
392 Versions of libdb before 4.2 are no longer supported.  4.2 and 4.3 both
393 work now.  4.2 support will be removed in some future release.
394
395 Prehistoric backwards-compatibility logic removed.  Only affects people
396 upgrading from long before 1.0 (who should upgrade to 1.0 and then to
397 1.1.)
398
399 ** Command Line
400
401 Tracks can be moved in the queue from the command line.
402
403 'disorder queue' now reports track IDs.
404
405 $pkgdatadir/completion.bash provides tab completion over commands and
406 options.
407
408 ** Web Interface
409
410 New 'cooked' preferences interface saves users having to know arcane
411 details of trackname preferences and so on.  Non-ASCII characters are
412 now properly supported in this context.
413
414 CGI arguments to the web interface are now checked for UTF-8 compliance.
415
416 Local Variables:
417 mode:outline
418 fill-column:72
419 End: