Allow people to select the old console behavior of white text on a black
[asterisk/asterisk.git] / UPGRADE.txt
1 =========================================================
2 === Information for upgrading from Asterisk 1.4 to 1.6
3 ===
4 ===
5 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
6 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
7 === UPGRADE.txt     -- Upgrade info for 1.4 to 1.6
8 =========================================================
9
10 AEL:
11
12 * Macros are now implemented underneath with the Gosub() application.
13   Heaven Help You if you wrote code depending on any aspect of this!
14   Previous to 1.6, macros were implemented with the Macro() app, which
15   provided a nice feature of auto-returning. The compiler will do its
16   best to insert a Return() app call at the end of your macro if you did
17   not include it, but really, you should make sure that all execution
18   paths within your macros end in "return;".
19
20 * The conf2ael program is 'introduced' in this release; it is in a rather
21   crude state, but deemed useful for making a first pass at converting
22   extensions.conf code into AEL. More intelligence will come with time.
23
24 Core:
25
26 * The 'languageprefix' option in asterisk.conf is now deprecated, and
27   the default sound file layout for non-English sounds is the 'new
28   style' layout introduced in Asterisk 1.4 (and used by the automatic
29   sound file installer in the Makefile).
30
31 * The ast_expr2 stuff has been modified to handle floating-point numbers.
32   Numbers of the format D.D are now acceptable input for the expr parser, 
33   Where D is a string of base-10 digits. All math is now done in "long double",
34   if it is available on your compiler/architecture. This was half-way between
35   a bug-fix (because the MATH func returns fp by default), and an enhancement.
36   Also, for those counting on, or needing, integer operations, a series of
37   'functions' were also added to the expr language, to allow several styles
38   of rounding/truncation, along with a set of common floating point operations,
39   like sin, cos, tan, log, pow, etc. The ability to call external functions
40   like CDR(), etc. was also added, without having to use the ${...} notation.
41  
42 * The delimiter passed to applications has been changed to the comma (','), as
43   that is what people are used to using within extensions.conf.  If you are
44   using realtime extensions, you will need to translate your existing dialplan
45   to use this separator.  To use a literal comma, you need merely to escape it
46   with a backslash ('\').  Another possible side effect is that you may need to
47   remove the obscene level of backslashing that was necessary for the dialplan
48   to work correctly in 1.4 and previous versions.  This should make writing
49   dialplans less painful in the future, albeit with the pain of a one-time
50   conversion.  If you would like to avoid this conversion immediately, set
51   pbx_realtime=1.4 in the [compat] section of asterisk.conf.  After
52   transitioning, set pbx_realtime=1.6 in the same section.
53
54 * For the same purpose as above, you may set res_agi=1.4 in the [compat]
55   section of asterisk.conf to continue to use the '|' delimiter in the EXEC
56   arguments of AGI applications.  After converting to use the ',' delimiter,
57   change this option to res_agi=1.6.
58
59 * The logger.conf option 'rotatetimestamp' has been deprecated in favor of
60   'rotatestrategy'.  This new option supports a 'rotate' strategy that more
61   closely mimics the system logger in terms of file rotation.
62
63 * The concise versions of various CLI commands are now deprecated. We recommend
64   using the manager interface (AMI) for application integration with Asterisk.
65
66 * The following core commands dealing with dialplan has been deprecated: 'core
67   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
68   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
69   instead.
70
71 * The silencethreshold used for various applications is now settable via a
72   centralized config option in dsp.conf.
73
74 * The logical value of spaces immediately preceding a standalone 0 previously
75   evaluated to true.  It now evaluates to false.  This has confused a good
76   many people in the past (typically because they failed to realize the space
77   had any significance).  Since this violates the Principle of Least Surprise,
78   it has been changed.
79
80 * The default console now will use colors according to the default background
81   color, instead of forcing the background color to black.  If you are using a
82   light colored background for your console, you may wish to use the option
83   flag '-W' to present better color choices for the various messages.  However,
84   if you'd prefer the old method of forcing colors to white text on a black
85   background, the compatiblity option -B is provided for this purpose.
86
87 Voicemail:
88
89 * The voicemail configuration values 'maxmessage' and 'minmessage' have
90   been changed to 'maxsecs' and 'minsecs' to clarify their purpose and
91   to make them more distinguishable from 'maxmsgs', which sets folder
92   size.  The old variables will continue to work in this version, albeit
93   with a deprecation warning.
94
95 * If you use any interface for modifying voicemail aside from the built in
96   dialplan applications, then the option "pollmailboxes" *must* be set in
97   voicemail.conf for message waiting indication (MWI) to work properly.  This
98   is because Voicemail notification is now event based instead of polling
99   based.  The channel drivers are no longer responsible for constantly manually
100   checking mailboxes for changes so that they can send MWI information to users.
101   Examples of situations that would require this option are web interfaces to
102   voicemail or an email client in the case of using IMAP storage.
103
104 * The externnotify script should accept an additional (last) parameter
105   containing the number of urgent messages in the INBOX.
106
107 Applications:
108
109 * SendImage() no longer hangs up the channel on transmission error or on
110   another type of error; in those cases, a FAILURE status is stored in 
111   SENDIMAGESTATUS and dialplan execution continues.  The possible return values
112   stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and UNSUPPORTED. ('OK' has
113   been replaced with 'SUCCESS', and 'NOSUPPORT' has been replaced with
114   'UNSUPPORTED').  This change makes the SendImage application more consistent
115   with other applications.
116
117 * ChanIsAvail() now has a 't' option, which allows the specified device
118   to be queried for state without consulting the channel drivers. This
119   performs mostly a 'ChanExists' sort of function.
120
121 * ChannelRedirect() will not terminate the channel that fails to do a
122   channelredirect as it has done previously. Instead CHANNELREDIRECT_STATUS
123   will reflect if the attempt was successful of not.
124
125 * SetCallerPres() has been replaced with the CALLERPRES() dialplan function
126   and is now deprecated.
127
128 * DISA()'s fifth argument is now an options argument.  If you have previously
129   used 'NOANSWER' in this argument, you'll need to convert that to the new
130   option 'n'.
131
132 * Macro() is now deprecated.  If you need subroutines, you should use the
133   Gosub()/Return() applications.  To replace MacroExclusive(), we have
134   introduced dialplan functions LOCK(), TRYLOCK(), and UNLOCK().  You may use
135   these functions in any location where you desire to ensure that only one
136   channel is executing that path at any one time.  The Macro() applications
137   are deprecated for performance reasons.  However, since Macro() has been
138   around for a long time and so many dialplans depend heavily on it, for the
139   sake of backwards compatibility it will not be removed .  It is also worth
140   noting that using both Macro() and GoSub() at the same time is _heavily_
141   discouraged.
142
143 * Read() now sets a READSTATUS variable on exit.  It does NOT automatically
144   return -1 (and hangup) anymore on error.  If you want to hangup on error,
145   you need to do so explicitly in your dialplan.
146
147 * Privacy() no longer uses privacy.conf, so any options must be specified
148   directly in the application arguments.
149
150 * MusicOnHold application now has duration parameter which allows specifying
151   timeout in seconds.
152
153 * WaitMusicOnHold application is now deprecated in favor of extended MusicOnHold.
154
155 * SetMusicOnHold is now deprecated. You should use Set(CHANNEL(musicclass)=...)
156   instead.
157
158 * While app_directory has always relied on having a voicemail.conf or users.conf file
159   correctly set up, it now is dependent on app_voicemail being compiled as well.
160
161 * The arguments in ExecIf changed a bit, to be more like other applications.
162   The syntax is now ExecIf(<cond>?appiftrue(args):appiffalse(args)).
163
164 * The behavior of the Set application now depends upon a compatibility option,
165   set in asterisk.conf.  To use the old 1.4 behavior, which allowed Set to take
166   multiple key/value pairs, set app_set=1.4 in [compat] in asterisk.conf.  To
167   use the new behavior, which permits variables to be set with embedded commas,
168   set app_set=1.6 in [compat] in asterisk.conf.  Note that you can have both
169   behaviors at the same time, if you switch to using MSet if you want the old
170   behavior.
171
172 Dialplan Functions:
173
174 * QUEUE_MEMBER_COUNT() has been deprecated in favor of the QUEUE_MEMBER() function. For
175   more information, issue a "show function QUEUE_MEMBER" from the CLI.
176
177 CDR:
178
179 * The cdr_sqlite module has been marked as deprecated in favor of
180   cdr_sqlite3_custom.  It will potentially be removed from the tree
181   after Asterisk 1.6 is released.
182
183 * The cdr_odbc module now uses res_odbc to manage its connections.  The
184   username and password parameters in cdr_odbc.conf, therefore, are no
185   longer used.  The dsn parameter now points to an entry in res_odbc.conf.
186
187 * The uniqueid field in the core Asterisk structure has been changed from a
188   maximum 31 character field to a 149 character field, to account for all
189   possible values the systemname prefix could be.  In the past, if the
190   systemname was too long, the uniqueid would have been truncated.
191
192 * The cdr_tds module now supports all versions of FreeTDS that contain
193   the db-lib frontend.  It will also now log the userfield variable if
194   the target database table contains a column for it.
195
196 Formats:
197
198 * format_wav: The GAIN preprocessor definition and source code that used it
199   is removed.  This change was made in response to user complaints of
200   choppiness or the clipping of loud signal peaks.  To increase the volume
201   of voicemail messages, use the 'volgain' option in voicemail.conf
202
203 Channel Drivers:
204
205 * SIP: a small upgrade to support the "Record" button on the SNOM360,
206   which sends a sip INFO message with a "Record: on" or "Record: off" 
207   header. If Asterisk is set up (via features.conf) to accept "One Touch Monitor"
208   requests (by default, via '*1'), then the user-configured dialpad sequence
209   is generated, and recording can be started and stopped via this button. The
210   file names and formats are all controlled via the normal mechanisms. If the
211   user has not configured the automon feature, the normal "415 Unsupported media type"
212   is returned, and nothing is done.
213
214 * SIP: The "call-limit" option is marked as deprecated. It still works in this version of
215   Asterisk, but will be removed in the following version. Please use the groupcount functions
216   in the dialplan to enforce call limits. The "limitonpeer" configuration option is
217   now renamed to "counteronpeer".
218
219 * SIP: The "username" option is now renamed to "defaultuser" to match "defaultip".
220   These are used only before registration to call a peer with the uri 
221         sip:defaultuser@defaultip
222   The "username" setting still work, but is deprecated and will not work in 
223   the next version of Asterisk.
224
225 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
226   and you should start using that function instead for retrieving information about
227   the channel in a technology-agnostic way.
228
229 * chan_local.c: the comma delimiter inside the channel name has been changed to a
230   semicolon, in order to make the Local channel driver compatible with the comma
231   delimiter change in applications.
232
233 * H323: The "tos" setting has changed name to "tos_audio" and "cos" to "cos_audio"
234   to be compatible with settings in sip.conf. The "tos" and "cos" configuration
235   is deprecated and will stop working in the next release of Asterisk.
236
237 * Console: A new console channel driver, chan_console, has been added to Asterisk.
238   This new module can not be loaded at the same time as chan_alsa or chan_oss.  The
239   default modules.conf only loads one of them (chan_oss by default).  So, unless you
240   have modified your modules.conf to not use the autoload option, then you will need
241   to modify modules.conf to add another "noload" line to ensure that only one of
242   these three modules gets loaded.
243
244 * DAHDI: The chan_zap module that supported PSTN interfaces using
245   Zaptel has been renamed to chan_dahdi, and only supports the DAHDI
246   telephony driver package for PSTN interfaces. See the
247   Zaptel-to-DAHDI.txt file for more details on this transition.
248
249 * DAHDI: The "msdstrip" option has been deprecated, as it provides no value over
250   the method of stripping digits in the dialplan using variable substring syntax.
251
252 Configuration:
253
254 * pbx_dundi.c: tos parameter changed to use new values. Old values like lowdelay,
255   lowcost and other is not acceptable now. Look into qos.tex for description of 
256   this parameter.
257
258 * queues.conf: the queue-lessthan sound file option is no longer available, and the
259   queue-round-seconds option no longer takes '1' as a valid parameter.
260
261 * If you have any third party modules which use a config file variable whose
262   name ends in a '+', please note that the append capability added to this
263   version may now conflict with that variable naming scheme.  An easy
264   workaround is to ensure that a space occurs between the '+' and the '=',
265   to differentiate your variable from the append operator.  This potential
266   conflict is unlikely, but is documented here to be thorough.
267
268 Manager:
269
270 * Manager has been upgraded to version 1.1 with a lot of changes. 
271   Please check doc/manager_1_1.txt for information
272
273 * The IAXpeers command output has been changed to more closely resemble the
274   output of the SIPpeers command.
275
276 * cdr_manager now reports at the "cdr" level, not at "call"  You may need to
277   change your manager.conf to add the level to existing AMI users, if they
278   want to see the CDR events generated.
279
280 * The Originate command now requires the Originate write permission.  For
281   Originate with the Application parameter, you need the additional System
282   privilege if you want to do anything that calls out to a subshell.
283
284 Queues:
285
286 * New queue log events ADDMEMBER and REMOVEMEMBER have been added.  Also, a
287   new value has been added to the TRANSFER event that indicates the caller's
288   original position in the queue they are being transfered from.
289
290 iLBC Codec:
291
292 * Previously, the Asterisk source code distribution included the iLBC
293   encoder/decoder source code, from Global IP Solutions
294   (http://www.gipscorp.com). This code is not licensed for
295   distribution, and thus has been removed from the Asterisk source
296   code distribution. If you wish to use codec_ilbc to support iLBC
297   channels in Asterisk, you can run the contrib/scripts/get_ilbc_source.sh
298   script to download the source and put it in the proper place in
299   the Asterisk build tree. Once that is done you can follow your normal
300   steps of building Asterisk. You will need to run 'menuselect' and enable
301   the iLBC codec in the 'Codec  Translators' category.