<p>George Joseph <strong>merged</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/12958">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Kevin Harwell: Looks good to me, but someone else must approve
Joshua Colp: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved; Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">res_musiconhold: Add new 'playlist' mode<br><br>Allow the list of files to be played to be provided explicitly in the<br>music class's configuration. The primary driver for this change is to<br>allow URLs to be used for MoH.<br><br>Change-Id: I9f43b80b43880980b18b2bee26ec09429d0b92fa<br>---<br>M configs/samples/extconfig.conf.sample<br>M configs/samples/musiconhold.conf.sample<br>A contrib/ast-db-manage/config/versions/fbb7766f17bc_add_playlist_to_moh.py<br>A doc/CHANGES-staging/moh-playlist.txt<br>M res/res_musiconhold.c<br>5 files changed, 139 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/configs/samples/extconfig.conf.sample b/configs/samples/extconfig.conf.sample</span><br><span>index 9e13cac..b633faf 100644</span><br><span>--- a/configs/samples/extconfig.conf.sample</span><br><span>+++ b/configs/samples/extconfig.conf.sample</span><br><span>@@ -95,6 +95,7 @@</span><br><span> ;queue_rules => odbc,asterisk</span><br><span> ;acls => odbc,asterisk</span><br><span> ;musiconhold => mysql,general</span><br><span style="color: hsl(120, 100%, 40%);">+;musiconhold_entry => mysql,general</span><br><span> ;queue_log => mysql,general</span><br><span> ;</span><br><span> ;</span><br><span>diff --git a/configs/samples/musiconhold.conf.sample b/configs/samples/musiconhold.conf.sample</span><br><span>index 741bde6..1090bbe 100644</span><br><span>--- a/configs/samples/musiconhold.conf.sample</span><br><span>+++ b/configs/samples/musiconhold.conf.sample</span><br><span>@@ -13,6 +13,7 @@</span><br><span> ; valid mode options:</span><br><span> ; files -- read files from a directory in any Asterisk supported</span><br><span> ; media format</span><br><span style="color: hsl(120, 100%, 40%);">+; playlist -- provide a fixed list of filenames or URLs to play</span><br><span> ; quietmp3 -- default</span><br><span> ; mp3 -- loud</span><br><span> ; mp3nb -- unbuffered</span><br><span>@@ -44,6 +45,22 @@</span><br><span> ; this, res_musiconhold will skip the files it is not able to</span><br><span> ; understand when it loads.</span><br><span> ;</span><br><span style="color: hsl(120, 100%, 40%);">+; =========</span><br><span style="color: hsl(120, 100%, 40%);">+; Playlist (native) music on hold</span><br><span style="color: hsl(120, 100%, 40%);">+; =========</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span style="color: hsl(120, 100%, 40%);">+; This mode is similar to 'files' mode in that it plays through a list</span><br><span style="color: hsl(120, 100%, 40%);">+; of files, but instead of scanning a directory the files are</span><br><span style="color: hsl(120, 100%, 40%);">+; explicitly configured using one or more 'entry' options.</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span style="color: hsl(120, 100%, 40%);">+; Each entry must be one of:</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span style="color: hsl(120, 100%, 40%);">+; * An absolute path to the file to be played, without an extension.</span><br><span style="color: hsl(120, 100%, 40%);">+; * A URL</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span style="color: hsl(120, 100%, 40%);">+; The entries are played in the order in which they appear in the</span><br><span style="color: hsl(120, 100%, 40%);">+; configuration. The 'sort' option is not used for this mode.</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span> </span><br><span> [default]</span><br><span> mode=files</span><br><span>@@ -71,6 +88,12 @@</span><br><span> ;directory=moh</span><br><span> ;sort=alpha ; Sort the files in alphabetical order.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+;[sales-queue-hold]</span><br><span style="color: hsl(120, 100%, 40%);">+;mode=playlist</span><br><span style="color: hsl(120, 100%, 40%);">+;entry=/var/lib/asterisk/sounds/en/yourcallisimportant</span><br><span style="color: hsl(120, 100%, 40%);">+;entry=http://example.local/sales-queue-hold-music.ulaw</span><br><span style="color: hsl(120, 100%, 40%);">+;entry=/var/lib/asterisk/moh/macroform-robot_dity</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> ; =========</span><br><span> ; Other (non-native) playback methods</span><br><span> ; =========</span><br><span>diff --git a/contrib/ast-db-manage/config/versions/fbb7766f17bc_add_playlist_to_moh.py b/contrib/ast-db-manage/config/versions/fbb7766f17bc_add_playlist_to_moh.py</span><br><span>new file mode 100644</span><br><span>index 0000000..0cb5ddb</span><br><span>--- /dev/null</span><br><span>+++ b/contrib/ast-db-manage/config/versions/fbb7766f17bc_add_playlist_to_moh.py</span><br><span>@@ -0,0 +1,54 @@</span><br><span style="color: hsl(120, 100%, 40%);">+"""add playlist to moh</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Revision ID: fbb7766f17bc</span><br><span style="color: hsl(120, 100%, 40%);">+Revises: 3a094a18e75b</span><br><span style="color: hsl(120, 100%, 40%);">+Create Date: 2019-09-18 10:24:18.731798</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+"""</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# revision identifiers, used by Alembic.</span><br><span style="color: hsl(120, 100%, 40%);">+revision = 'fbb7766f17bc'</span><br><span style="color: hsl(120, 100%, 40%);">+down_revision = '3a094a18e75b'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+from alembic import op</span><br><span style="color: hsl(120, 100%, 40%);">+import sqlalchemy as sa</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def enum_update(table_name, column_name, enum_name, enum_values):</span><br><span style="color: hsl(120, 100%, 40%);">+ if op.get_context().bind.dialect.name != 'postgresql':</span><br><span style="color: hsl(120, 100%, 40%);">+ if op.get_context().bind.dialect.name == 'mssql':</span><br><span style="color: hsl(120, 100%, 40%);">+ op.drop_constraint('ck_musiconhold_mode_moh_mode_values', 'musiconhold')</span><br><span style="color: hsl(120, 100%, 40%);">+ op.alter_column(table_name, column_name,</span><br><span style="color: hsl(120, 100%, 40%);">+ type_=sa.Enum(*enum_values, name=enum_name))</span><br><span style="color: hsl(120, 100%, 40%);">+ return</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Postgres requires a few more steps</span><br><span style="color: hsl(120, 100%, 40%);">+ tmp = enum_name + '_tmp'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ op.execute('ALTER TYPE ' + enum_name + ' RENAME TO ' + tmp)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ updated = sa.Enum(*enum_values, name=enum_name)</span><br><span style="color: hsl(120, 100%, 40%);">+ updated.create(op.get_bind(), checkfirst=False)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ op.execute('ALTER TABLE ' + table_name + ' ALTER COLUMN ' + column_name +</span><br><span style="color: hsl(120, 100%, 40%);">+ ' TYPE ' + enum_name + ' USING mode::text::' + enum_name)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ op.execute('DROP TYPE ' + tmp)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def upgrade():</span><br><span style="color: hsl(120, 100%, 40%);">+ op.create_table(</span><br><span style="color: hsl(120, 100%, 40%);">+ 'musiconhold_entry',</span><br><span style="color: hsl(120, 100%, 40%);">+ sa.Column('name', sa.String(80), primary_key=True, nullable=False),</span><br><span style="color: hsl(120, 100%, 40%);">+ sa.Column('position', sa.Integer, primary_key=True, nullable=False),</span><br><span style="color: hsl(120, 100%, 40%);">+ sa.Column('entry', sa.String(1024), nullable=False)</span><br><span style="color: hsl(120, 100%, 40%);">+ )</span><br><span style="color: hsl(120, 100%, 40%);">+ op.create_foreign_key('fk_musiconhold_entry_name_musiconhold', 'musiconhold_entry', 'musiconhold', ['name'], ['name'])</span><br><span style="color: hsl(120, 100%, 40%);">+ enum_update('musiconhold', 'mode', 'moh_mode_values',</span><br><span style="color: hsl(120, 100%, 40%);">+ ['custom', 'files', 'mp3nb', 'quietmp3nb', 'quietmp3', 'playlist'])</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def downgrade():</span><br><span style="color: hsl(120, 100%, 40%);">+ enum_update('musiconhold', 'mode', 'moh_mode_values',</span><br><span style="color: hsl(120, 100%, 40%);">+ ['custom', 'files', 'mp3nb', 'quietmp3nb', 'quietmp3'])</span><br><span style="color: hsl(120, 100%, 40%);">+ op.drop_table('musiconhold_entry')</span><br><span>diff --git a/doc/CHANGES-staging/moh-playlist.txt b/doc/CHANGES-staging/moh-playlist.txt</span><br><span>new file mode 100644</span><br><span>index 0000000..14cb022</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/moh-playlist.txt</span><br><span>@@ -0,0 +1,5 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: res_musiconhold</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+A new mode - playlist - has been added to res_musiconhold. This mode allows the</span><br><span style="color: hsl(120, 100%, 40%);">+user to specify the files (or URLs) to play explicitly by putting them directly</span><br><span style="color: hsl(120, 100%, 40%);">+in musiconhold.conf.</span><br><span>diff --git a/res/res_musiconhold.c b/res/res_musiconhold.c</span><br><span>index f770075..1bacb11 100644</span><br><span>--- a/res/res_musiconhold.c</span><br><span>+++ b/res/res_musiconhold.c</span><br><span>@@ -1081,6 +1081,20 @@</span><br><span> ast_copy_string(mohclass->name, var->value, sizeof(mohclass->name));</span><br><span> } else if (!strcasecmp(var->name, "mode")) {</span><br><span> ast_copy_string(mohclass->mode, var->value, sizeof(mohclass->mode));</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (!strcasecmp(var->name, "entry")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ast_begins_with(var->value, "/") || ast_begins_with(var->value, "http://") || ast_begins_with(var->value, "https://")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ char *dup = ast_strdup(var->value);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!dup) {</span><br><span style="color: hsl(120, 100%, 40%);">+ continue;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ast_begins_with(dup, "/") && strrchr(dup, '.')) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(LOG_WARNING, "The playlist entry '%s' may include an extension, which could prevent it from playing.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ dup);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_VECTOR_APPEND(&mohclass->files, dup);</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(LOG_ERROR, "Playlist entries must be a URL or absolute path, '%s' provided.\n", var->value);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> } else if (!strcasecmp(var->name, "directory")) {</span><br><span> ast_copy_string(mohclass->dir, var->value, sizeof(mohclass->dir));</span><br><span> } else if (!strcasecmp(var->name, "application")) {</span><br><span>@@ -1130,6 +1144,8 @@</span><br><span> }</span><br><span> }</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_VECTOR_COMPACT(&mohclass->files);</span><br><span> }</span><br><span> </span><br><span> static int moh_scan_files(struct mohclass *class) {</span><br><span>@@ -1333,6 +1349,13 @@</span><br><span> }</span><br><span> return -1;</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (!strcasecmp(moh->mode, "playlist")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!AST_VECTOR_SIZE(&moh->files)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (unref) {</span><br><span style="color: hsl(120, 100%, 40%);">+ moh = mohclass_unref(moh, "unreffing potential new moh class (no playlist entries)");</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> } else if (!strcasecmp(moh->mode, "mp3") || !strcasecmp(moh->mode, "mp3nb") ||</span><br><span> !strcasecmp(moh->mode, "quietmp3") || !strcasecmp(moh->mode, "quietmp3nb") ||</span><br><span> !strcasecmp(moh->mode, "httpmp3") || !strcasecmp(moh->mode, "custom")) {</span><br><span>@@ -1485,6 +1508,32 @@</span><br><span> static struct ast_variable *load_realtime_musiconhold(const char *name)</span><br><span> {</span><br><span> struct ast_variable *var = ast_load_realtime("musiconhold", "name", name, SENTINEL);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (var) {</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *mode = ast_variable_find_in_list(var, "mode");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ast_strings_equal(mode, "playlist")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_variable *entries = ast_load_realtime("musiconhold_entry", "name", name, SENTINEL);</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_variable *cur = entries;</span><br><span style="color: hsl(120, 100%, 40%);">+ size_t entry_count = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ for (; cur; cur = cur->next) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!strcmp(cur->name, "entry")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_variable *dup = ast_variable_new(cur->name, cur->value, "");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (dup) {</span><br><span style="color: hsl(120, 100%, 40%);">+ entry_count++;</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_variable_list_append(&var, dup);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_variables_destroy(entries);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (entry_count == 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Behave as though this class doesn't exist */</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_variables_destroy(var);</span><br><span style="color: hsl(120, 100%, 40%);">+ var = NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> if (!var) {</span><br><span> ast_log(LOG_WARNING,</span><br><span> "Music on Hold class '%s' not found in memory/database. "</span><br><span>@@ -1551,7 +1600,7 @@</span><br><span> ast_variables_destroy(var);</span><br><span> </span><br><span> if (ast_strlen_zero(mohclass->dir)) {</span><br><span style="color: hsl(0, 100%, 40%);">- if (!strcasecmp(mohclass->mode, "custom")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!strcasecmp(mohclass->mode, "custom") || !strcasecmp(mohclass->mode, "playlist")) {</span><br><span> strcpy(mohclass->dir, "nodir");</span><br><span> } else {</span><br><span> ast_log(LOG_WARNING, "A directory must be specified for class '%s'!\n", mohclass->name);</span><br><span>@@ -1605,6 +1654,11 @@</span><br><span> }</span><br><span> ast_set_flag(mohclass, MOH_RANDOMIZE);</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (!strcasecmp(mohclass->mode, "playlist")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!AST_VECTOR_SIZE(&mohclass->files)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ mohclass = mohclass_unref(mohclass, "unreffing potential mohclass (no playlist entries)");</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> } else if (!strcasecmp(mohclass->mode, "mp3") || !strcasecmp(mohclass->mode, "mp3nb") || !strcasecmp(mohclass->mode, "quietmp3") || !strcasecmp(mohclass->mode, "quietmp3nb") || !strcasecmp(mohclass->mode, "httpmp3") || !strcasecmp(mohclass->mode, "custom")) {</span><br><span> </span><br><span> if (!strcasecmp(mohclass->mode, "custom"))</span><br><span>@@ -1846,7 +1900,7 @@</span><br><span> ast_copy_string(class->name, cat, sizeof(class->name));</span><br><span> </span><br><span> if (ast_strlen_zero(class->dir)) {</span><br><span style="color: hsl(0, 100%, 40%);">- if (!strcasecmp(class->mode, "custom")) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!strcasecmp(class->mode, "custom") || !strcasecmp(class->mode, "playlist")) {</span><br><span> strcpy(class->dir, "nodir");</span><br><span> } else {</span><br><span> ast_log(LOG_WARNING, "A directory must be specified for class '%s'!\n", class->name);</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/12958">change 12958</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/12958"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 17 </div>
<div style="display:none"> Gerrit-Change-Id: I9f43b80b43880980b18b2bee26ec09429d0b92fa </div>
<div style="display:none"> Gerrit-Change-Number: 12958 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Sean Bright <sean.bright@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Joshua Colp <jcolp@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>