Add log-caller-id-name option to log Caller ID Name in queue log

Add log-caller-id-name option to log Caller ID Name in queue log

Fixes: #1133

UserNote:This patch adds a global configuration option, log-caller-id-name, to queues.conf to control whether the Caller ID name is logged as parameter 4 when a call enters a queue. With log-caller-id-name=yes, the queue log entry will include the URL (if specified), the caller ID number, the queue position, and—if allowed by the existing log_restricted_caller_id rules—the caller ID name. Any '|' characters in the caller ID name will be replaced with '_'.
With log-caller-id-name=no (the default), only the URL, caller ID number, and queue position are logged. Accordingly, the documented log format has been updated to:

ENTERQUEUE(url|callerid|queue_position[|calleridname])

Author: phoneben

Diff for: docs/Operation/Logging/Queue-Logs.md

@@ -36,7 +36,7 @@ These are the events (and associated information) in the queue log:
 * COMPLETECALLER(holdtime|calltime|origposition) - The caller was connected to an agent, and the call was terminated normally by the caller. The caller's hold time and the length of the call are both recorded. The caller's original position in the queue is recorded in origposition.
 * CONFIGRELOAD - The configuration has been reloaded (e.g. with asterisk -rx reload)
 * CONNECT(holdtime|bridgedchanneluniqueid|ringtime) - The caller was connected to an agent. Hold time represents the amount of time the caller was on hold. The bridged channel unique ID contains the unique ID of the queue member channel that is taking the call. This is useful when trying to link recording filenames to a particular call in the queue. Ringtime represents the time the queue members phone was ringing prior to being answered.
-* ENTERQUEUE(url|callerid|origposition[|calleridname]) – A call has entered the queue. The log entry always includes the URL (if specified), the Caller ID Number, and the caller's original position in the queue (recorded in origposition). If the global option log_cidname is set to yes in queues.conf and the caller’s Caller ID Name is permitted (i.e., not restricted), the Caller ID Name is appended as an optional fourth parameter.
+* ENTERQUEUE(url|callerid|origposition[|calleridname]) – A call has entered the queue. The log entry always includes the URL (if specified), the Caller ID Number, and the caller's original position in the queue (recorded in origposition). If the  option log-caller-id-name is enabled in queues.conf and Caller ID would otherwise be logged (see 'log-restricted-caller-id'), the Caller ID Name is appended as an fourth column.
 * EXITEMPTY(position|origposition|waittime) - The caller was exited from the queue forcefully because the queue had no reachable members and it's configured to do that to callers when there are no reachable members. The position is the caller's position in the queue when they hungup, the origposition is the original position the caller was when they first entered the queue, and the waittime is how long the call had been waiting in the queue at the time of disconnect.
 * EXITWITHKEY(key|position|origposition|waittime) - The caller elected to use a menu key to exit the queue. The key and the caller's position in the queue are recorded. The caller's entry position and amoutn of time waited is also recorded.
 * EXITWITHTIMEOUT(position|origposition|waittime) - The caller was on hold too long and the timeout expired. The position in the queue when the timeout occurred, the entry position, and the amount of time waited are logged.