Changeset 7262

Timestamp:

06/01/2018 05:35:03 PM (8 years ago)

Author:

iandunn

Message:

WordCamp Post Types: Provide shareable link for favorited sessions.

Props egmanekki.
Fixes #2733.

Location:

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types

Files:

• css/shortcodes.css (modified) (1 diff)
• js/favourite-sessions.js (modified) (7 diffs)
• wc-post-types.php (modified) (3 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/css/shortcodes.css

@@ -130 +130 @@
         bottom: 50px;
         right: 100px;
-        width: 200px;
+        width: 350px;
         background: #dcdcdc;
         font-size: 12px;

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/js/favourite-sessions.js

@@ -1 +1 @@
 jQuery( document ).ready( function ( $ ) {
+        var favSessionsUrlSlug = 'fav-sessions=';
+
+        function getUrlParams() {
+                var url       = decodeURIComponent( window.location.search ),
+                    urlParams = {};
+
+                url.replace( /[?&]+([^=&]+)=([^&]*)/gi, function( str, key, value ) {
+                        urlParams[ key ] = value;
+                } );
+
+                return urlParams;
+        }
+
         var FavSessions = {
                 favSessKey: 'favourite_sessions',
-
-                get: function () {
-                        var favSessions = JSON.parse( localStorage.getItem( this.favSessKey ) );
-
-                        if ( ! favSessions ) {
-                                favSessions = {};
+                useLocalStorage: 'local_storage',
+                useUrlSessions:  'URL',
+
+                get: function() {
+                        if ( this.primarySource == this.useLocalStorage ) {
+                                var favSessions = JSON.parse( localStorage.getItem( this.favSessKey ) );
+
+                                if ( ! favSessions ) {
+                                        favSessions = {};
+                                }
+                        } else {
+                                favSessions = this.favSessionsFromUrl();
                         }
 
@@ -14 +33 @@
 
                 toggleSession: function ( sessionId ) {
+                        if ( this.primarySource !== this.useLocalStorage ) {
+                                return;
+                        }
+
                         var favSessions = this.get();
 
@@ -24 +47 @@
                         localStorage.setItem( this.favSessKey, JSON.stringify( favSessions ) );
                 },
+
+                getSessionsForLink: function() {
+                        var favSessions = this.get();
+
+                        return Object.keys( favSessions ).join();
+                },
+
+                favSessionsFromUrl: function() {
+                        var urlParams       = getUrlParams(),
+                            urlSlugPosition = favSessionsUrlSlug.slice( 0, favSessionsUrlSlug.length - 1 ),
+                            favSessionIds   = urlParams[ urlSlugPosition ].split( ',' ),
+                            favSessions     = {};
+
+                        for ( var i = 0; i < favSessionIds.length; i++ ) {
+                                favSessions[ favSessionIds[ i ] ] = true;
+                        }
+
+                        return favSessions;
+                },
+
+                updateBasedOnLink: function() {
+                        favSessions = this.favSessionsFromUrl();
+
+                        localStorage.setItem( this.favSessKey, JSON.stringify( favSessions ) );
+
+                        return this.get();
+                },
         };
+
+        // Use local storage for session source for fetching & target for saving by default.
+        FavSessions.primarySource = FavSessions.useLocalStorage;
 
         function switchCellAppearance( sessionId ) {
@@ -50 +103 @@
         }
 
+        function updateShareLink() {
+                var favSessionIds   = FavSessions.getSessionsForLink(),
+                    urlParams       = getUrlParams(),
+                    baseURL         = window.location.href,
+                    paramsPosition  = baseURL.indexOf( '?' ),
+                    urlSlugPosition = favSessionsUrlSlug.slice( 0, favSessionsUrlSlug.length - 1 );
+
+                if ( -1 !== paramsPosition ) {
+                        baseURL = baseURL.slice( 0, paramsPosition );
+                }
+
+                urlParams[ urlSlugPosition ] = favSessionIds;
+
+                // Don't include empty URL parameter.
+                if ( '' === favSessionIds ) {
+                        delete urlParams[ urlSlugPosition ];
+                }
+
+                var favSessionsLink = baseURL + '?' + $.param( urlParams );
+
+                $( '#fav-sessions-link' ).text( favSessionsLink );
+                $( '#fav-sessions-link' ).prop( 'href', favSessionsLink );
+        }
+
         function switchSessionFavourite( sessionId ) {
                 FavSessions.toggleSession( sessionId );
                 switchCellAppearance( sessionId );
                 switchEmailFavButton();
+                updateShareLink();
         }
 
@@ -63 +141 @@
                 }
 
+                /*
+                 * The user has already saved some sessions in local storage, but is now
+                 * loading a shared link. We need to determine whether they intend to overwrite
+                 * their saved sessions with those in the link, or if they just want to view
+                 * the link's sessions and then discard them, so that their saved sessions remain
+                 * in tact.
+                 */
+                var currentUrl = window.location.href;
+
+                if ( currentUrl.indexOf( favSessionsUrlSlug ) > -1 ) {
+                        var overwrite = confirm( favSessionsPhpObject.i18n.overwriteFavSessions );
+
+                        if ( true === overwrite ) {
+                                FavSessions.primarySource = FavSessions.useLocalStorage;
+                                favSessions               = FavSessions.updateBasedOnLink( currentUrl );
+
+                                $( '.fav-session-button' ).attr( 'title', '' );
+                                $( '.fav-session-button' ).fadeTo( 0, 1 );
+                        } else {
+                                FavSessions.primarySource = FavSessions.useUrlSessions;
+                                favSessions               = FavSessions.get();
+
+                                /*
+                                 * Deactivate interaction with favourite session buttons,
+                                 * since the use chose to not overwrite their saved sessions.
+                                 */
+                                $( '.fav-session-button' ).attr( 'title', favSessionsPhpObject.i18n.buttonDisabledNote );
+                                $( '.fav-session-button' ).fadeTo( 0, 0.5 );
+                                $( '.fav-session-button' ).css( 'color', '#e7e7e7' );
+                        }
+                }
+
+                if ( {} === favSessions ) {
+                        return;
+                }
+
                 // Highlight favourite sessions in table.
                 var sessionIds = Object.keys( favSessions );
@@ -75 +189 @@
 
                 switchEmailFavButton();
+                updateShareLink();
         }
 
@@ -119 +234 @@
                 event.preventDefault();
 
-                var elem = $( this );
-                var sessionId = elem.parent().parent().data( 'session-id' );
-                switchSessionFavourite( sessionId );
+                if ( FavSessions.primarySource == FavSessions.useLocalStorage ) {
+                        var elem      = $( this ),
+                            sessionId = elem.parent().parent().data( 'session-id' );
+
+                        switchSessionFavourite( sessionId );
+                } else {
+                        alert( favSessionsPhpObject.i18n.buttonDisabledAlert );
+                }
 
                 return false;

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/wc-post-types.php

@@ -732 +732 @@
                                         'reqTimeOut' => esc_html__( 'Sorry, the email request timed out.', 'wordcamporg' ),
                                         'otherError' => esc_html__( 'Sorry, the email request failed.',    'wordcamporg' ),
+                                        'overwriteFavSessions' => esc_html__( 'You already have some sessions saved. Would you like to overwrite those with the shared sessions that you are viewing?', 'wordcamporg' ),
+                                        'buttonDisabledAlert'  => esc_html__( 'Interaction with favorite sessions disabled in share sessions view. Please click on schedule menu link to pick sessions.', 'wordcamporg' ),
+                                        'buttonDisabledNote'   => esc_html__( 'Button disabled.', 'wordcamporg' ),
                                 ),
                         )
@@ -765 +768 @@
                                 <?php endif; ?>
 
+                                <div class="fav-session-tablinks" id="fav-session-btn-link">
+                                        <?php esc_html_e( 'Link', 'wordcamporg' ); ?>
+                                </div>
+
                                 <div class="fav-session-tablinks" id="fav-session-btn-print">
                                         <?php esc_html_e( 'Print', 'wordcamporg' ); ?>
@@ -786 +793 @@
                                 </div>
                         <?php endif; ?>
+
+                        <div id="fav-session-tab-link" class="fav-session-share-tabcontent">
+                                <?php esc_html_e( 'Shareable link:', 'wordcamporg' ); ?><br />
+                                <a id="fav-sessions-link" href=""></a>
+                        </div>
 
                         <div id="fav-session-tab-print" class="fav-session-share-tabcontent">