[Rt-commit] rt branch, 4.4/ticket-history-infinite-scroll, created. rt-4.2.11-235-gf6596c4
Dustin Graves
dustin at bestpractical.com
Thu Oct 8 17:50:27 EDT 2015
The branch, 4.4/ticket-history-infinite-scroll has been created
at f6596c4047af1366672b6cdc5581d1a1dc89e318 (commit)
- Log -----------------------------------------------------------------
commit f6596c4047af1366672b6cdc5581d1a1dc89e318
Author: Dustin Graves <dustin at bestpractical.com>
Date: Thu Oct 1 17:25:09 2015 +0000
add infinite scrolling and infinite scroll with gradual link to load page
Fixes: T#154449
diff --git a/lib/RT/Config.pm b/lib/RT/Config.pm
index bd321ee..f00ed06 100644
--- a/lib/RT/Config.pm
+++ b/lib/RT/Config.pm
@@ -390,11 +390,12 @@ our %META;
Widget => '/Widgets/Form/Select',
WidgetArguments => {
Description => 'Show history', #loc
- Values => [qw(delay click always)],
+ Values => [qw(delay click always continuous)],
ValuesLabel => {
- delay => "after the rest of the page loads", #loc
- click => "after clicking a link", #loc
- always => "immediately", #loc
+ delay => "after the rest of the page loads", #loc
+ click => "after clicking a link", #loc
+ always => "immediately", #loc
+ continuous => "as you scroll", #loc
},
},
},
diff --git a/share/html/Elements/ShowHistoryPage b/share/html/Elements/ShowHistoryPage
new file mode 100644
index 0000000..bc76d03
--- /dev/null
+++ b/share/html/Elements/ShowHistoryPage
@@ -0,0 +1,155 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+%# <sales at bestpractical.com>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<%ARGS>
+$Object
+$Transactions => $Object->SortedTransactions
+$Attachments => $Object->Attachments( WithHeaders => 1 )
+$AttachmentContent => $Object->TextAttachments
+$ShowHeaders => 0
+$PathPrefix => ''
+</%ARGS>
+<%INIT>
+my $trans_content = {};
+my $trans_attachments = {};
+
+for my $content (@{$AttachmentContent->ItemsArrayRef()}) {
+ $trans_content->{$content->TransactionId}->{$content->Id} = $content;
+}
+
+for my $attachment (@{$Attachments->ItemsArrayRef()}) {
+ my $tmp = $trans_attachments->{ $attachment->TransactionId } ||= {};
+ push @{ $tmp->{ $attachment->Parent || 0 } ||= [] }, $attachment;
+}
+
+{
+ my %tmp = (
+ DisplayPath => 'Display.html',
+ AttachmentPath => 'Attachment',
+ UpdatePath => 'Update.html',
+ ForwardPath => 'Forward.html',
+ EmailRecordPath => 'ShowEmailRecord.html',
+ EncryptionPath => 'Crypt.html',
+ );
+
+ my $prefix = $ARGS{PathPrefix}||'';
+ while ( my ($arg, $path) = each %tmp ) {
+ next if defined $ARGS{ $arg };
+ $ARGS{ $arg } = $prefix.$path;
+ }
+}
+
+my $record_type = $Object->RecordType;
+my $histid = "\L$record_type\E-" . $Object->id . "-history";
+
+my $HasTxnCFs = ($Object->can("TransactionCustomFields") and $Object->TransactionCustomFields->Count);
+</%INIT>
+<%perl>
+$m->callback( %ARGS, Object => $Object, CallbackName => 'BeforeTransactions' );
+
+# Properly set starting index
+my $i = 0;
+
+my $Transaction;
+
+while ( $Transaction = $Transactions->Next ) {
+ my $skip = 0;
+
+ # Skip display of SetWatcher transactions for ticket Owner groups. Owner
+ # was a single member role group and denormalized into a column well before
+ # the generic role group handling and transactions came about. For
+ # tickets, we rely on rendering ownership changes using the Set-Owner
+ # transaction. For all other record types, or even potential ticket single
+ # role groups which aren't Owner, we use SetWatcher to render history and
+ # skip the Set transactions. This complication is necessary to avoid
+ # creating backdated transactions on upgrade which normalize to one type or
+ # another.
+ #
+ # These conditions assumes ticket Owner is a single-member denormalized
+ # role group, which is safe since that is unlikely to ever change in the
+ # future.
+ if ($Object->isa("RT::Ticket") and ($Transaction->Field || '') eq "Owner") {
+ $skip = 1 if $Transaction->Type eq "SetWatcher";
+ } else {
+ $skip = 1 if $Transaction->Type eq "Set"
+ and $Transaction->Field
+ and $Object->DOES("RT::Record::Role::Roles")
+ and $Object->HasRole( $Transaction->Field )
+ and $Object->RoleGroup( $Transaction->Field )->SingleMemberRoleGroupColumn;
+ }
+
+ $m->callback(
+ %ARGS,
+ Transaction => $Transaction,
+ skip => \$skip,
+ CallbackName => 'SkipTransaction',
+ );
+ next if $skip;
+
+ # ARGS is first because we're clobbering the "Attachments" parameter
+ $m->comp( 'ShowTransaction',
+ %ARGS,
+ Object => $Object,
+ Transaction => $Transaction,
+ ShowHeaders => $ShowHeaders,
+ RowNum => $i,
+ Attachments => $trans_attachments->{$Transaction->id} || {},
+ AttachmentContent => $trans_content,
+ HasTxnCFs => $HasTxnCFs,
+ );
+
+ # manually flush the content buffer after each txn,
+ # so the user sees some update
+ $m->flush_buffer;
+
+ $i++;
+}
+
+# abort if we have no transactions, so the client knows we had no results
+$m->abort() unless ($Transaction);
+</%perl>
+<script type="text/javascript">ReplaceUserReferences()</script>
diff --git a/share/html/Elements/ShowTransaction b/share/html/Elements/ShowTransaction
index 1018ec6..85d7016 100644
--- a/share/html/Elements/ShowTransaction
+++ b/share/html/Elements/ShowTransaction
@@ -45,7 +45,7 @@
%# those contributions and any derivatives thereof.
%#
%# END BPS TAGGED BLOCK }}}
-<div class="<% join ' ', @classes %>">
+<div class="<% join ' ', @classes %>" data-transaction-id="<% $Transaction->id %>">
<div class="metadata">
<span class="type">
<a name="txn-<% $Transaction->id %>" \
diff --git a/share/html/Helpers/TicketHistoryPage b/share/html/Helpers/TicketHistoryPage
new file mode 100644
index 0000000..b112dce
--- /dev/null
+++ b/share/html/Helpers/TicketHistoryPage
@@ -0,0 +1,95 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+%# <sales at bestpractical.com>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<%ARGS>
+$id
+$oldestTransactionsFirst
+$lastTransactionId => undef
+$transactionId => undef
+</%ARGS>
+<%INIT>
+my $TicketObj = RT::Ticket->new($session{'CurrentUser'});
+$TicketObj->Load($id);
+
+my $attachments = $TicketObj->Attachments;
+my $attachment_content = $TicketObj->TextAttachments;
+my %extra_args;
+$m->callback( CallbackName => 'ExtraShowHistoryArguments', Ticket => $TicketObj, ExtraArgs => \%extra_args );
+
+my $transactions = $TicketObj->Transactions;
+my $order = $oldestTransactionsFirst ? 'ASC' : 'DESC';
+if ($lastTransactionId) {
+ $transactions->Limit(
+ FIELD => 'id',
+ OPERATOR => $oldestTransactionsFirst ? '>' : '<',
+ VALUE => $lastTransactionId
+ );
+}
+$transactions->OrderByCols(
+ { FIELD => 'Created', ORDER => $order },
+ { FIELD => 'id', ORDER => $order },
+);
+if ($transactionId) {
+ $transactions->Limit(
+ FIELD => 'id',
+ OPERATOR => $oldestTransactionsFirst ? '<=' : '>=',
+ VALUE => $transactionId
+ );
+} else {
+ $transactions->RowsPerPage(10);
+ $transactions->FirstPage();
+}
+</%INIT>
+<& /Elements/ShowHistoryPage,
+ Object => $TicketObj,
+ ShowHeaders => $ARGS{'ShowHeaders'},
+ Attachments => $attachments,
+ AttachmentContent => $attachment_content,
+ Transactions => $transactions,
+ %extra_args,
+ &>
+% $m->abort();
diff --git a/share/html/Ticket/Display.html b/share/html/Ticket/Display.html
index 6f57083..6765d5d 100644
--- a/share/html/Ticket/Display.html
+++ b/share/html/Ticket/Display.html
@@ -67,7 +67,11 @@
% $m->callback( Ticket => $TicketObj, %ARGS, Transactions => $transactions, Attachments => $attachments, CallbackName => 'BeforeShowHistory' );
% my $ShowHistory = RT->Config->Get("ShowHistory", $session{'CurrentUser'});
-% if ($ShowHistory eq "delay") {
+% if ($ShowHistory eq "continuous") {
+ <& /Ticket/Elements/ContinuousShowHistory,
+ Ticket => $TicketObj
+ &>
+% } elsif ($ShowHistory eq "delay") {
<& /Ticket/Elements/DelayShowHistory,
Ticket => $TicketObj,
ShowHeaders => $ARGS{'ShowHeaders'},
diff --git a/share/html/Ticket/Elements/ContinuousShowHistory b/share/html/Ticket/Elements/ContinuousShowHistory
new file mode 100644
index 0000000..09087a9
--- /dev/null
+++ b/share/html/Ticket/Elements/ContinuousShowHistory
@@ -0,0 +1,208 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+%# <sales at bestpractical.com>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<%ARGS>
+$Ticket
+</%ARGS>
+<%INIT>
+my %params = %ARGS;
+delete $params{Ticket};
+
+my $url = RT->Config->Get('WebPath') . "/Helpers/TicketHistoryPage?" .
+ $m->comp('/Elements/QueryString', %params, id => $Ticket->id );
+
+my %extra_args;
+$m->callback( CallbackName => 'ExtraShowHistoryArguments', Ticket => $Ticket, ExtraArgs => \%extra_args );
+
+my $ShowDisplayModes = 1 || $extra_args{'ShowDisplayModes'};
+my $ShowTitle = 1 || $extra_args{'ShowTitle'};
+my $ShowHeaders = 0 || $extra_args{'ShowHeaders'};
+
+my $record_type = $Ticket->RecordType;
+my $histid = "\L$record_type\E-" . $Ticket->id . "-history";
+
+my $oldestTransactionsFirst = RT->Config->Get("OldestTransactionsFirst", $session{CurrentUser});
+</%INIT>
+<div id="delayed_ticket_history">
+<div class="history <% lc $record_type %>" id="<% $histid %>">
+<%perl>
+if ( $ShowDisplayModes or $ShowTitle ) {
+ my $title = $ShowTitle
+ ? loc('History')
+ : ' ';
+
+ my $titleright = '';
+ if ( $ShowDisplayModes ) {
+ if ( RT->Config->Get( 'QuoteFolding', $session{CurrentUser} ) ) {
+ my $open_all = $m->interp->apply_escapes( loc("Show all quoted text"), 'j' );
+ my $open_html = $m->interp->apply_escapes( loc("Show all quoted text"), 'h' );
+ my $close_all = $m->interp->apply_escapes( loc("Hide all quoted text"), 'j' );
+ $titleright .= '<a href="#" data-direction="open" '
+ . qq{onclick="return toggle_all_folds(this, $open_all, $close_all);"}
+ . ">$open_html</a> — ";
+ }
+
+ if ($ShowHeaders) {
+ $titleright .= qq{<a href="?ForceShowHistory=1;id=} .
+ $Ticket->id.qq{#$histid">} .
+ loc("Show brief headers") .
+ qq{</a>};
+ } else {
+ $titleright .= qq{<a href="?ForceShowHistory=1;ShowHeaders=1;id=} .
+ $Ticket->id.qq{#$histid">} .
+ loc("Show full headers") .
+ qq{</a>};
+ }
+ }
+</%perl>
+<& /Widgets/TitleBoxStart, title => $title, titleright_raw => $titleright &>
+% }
+
+<div class="history-container">
+
+% if ($ShowDisplayModes or $ShowTitle) {
+ <& /Widgets/TitleBoxEnd &>
+% }
+
+</div>
+</div>
+</div>
+
+<script type="text/javascript">
+jQuery(function(){
+ var isLoading = false, // prevent multiple simultaneous load events
+ disableLoading = false, // prevent repeated fruitless attempts
+ loadDistanceFromBottom = 600, // to load before bottom of page is reached
+ lastTransactionId = null,
+ hash = window.location.hash,
+ hashTransactionId = null;
+
+ var oldestTransactionsFirst = <% $oldestTransactionsFirst || 0 %>;
+
+ var removeLoadingMessage = function() {
+ var loadingMessages = jQuery('.loading-message');
+ if (loadingMessages.length) loadingMessages.remove();
+ };
+
+ var removeLoadLink = function() {
+ var loadLink = jQuery('.error-load-history');
+ if (loadLink.length) loadLink.remove();
+ };
+
+ var showLoadingMessage = function() {
+ removeLoadingMessage();
+ var loadingMessage = jQuery('<span class="loading-message"><&|/l&>Loading...</&></span>');
+ jQuery(".history-container").append(loadingMessage);
+ };
+
+ var loadingError = function(reason) {
+ removeLoadingMessage();
+ disableLoading = true;
+ removeLoadLink();
+ var loadLink = jQuery('<div class="error-load-history"><&|/l&>Could not load ticket history. Reason: </&>' + reason + '.<br/><a href="#"><&|/l&>Try again</&></a></div>');
+ jQuery(".history-container").append(loadLink);
+ };
+
+ var loadHistoryPage = function() {
+ if (isLoading || disableLoading) return;
+
+ isLoading = true;
+ showLoadingMessage();
+
+ var queryString = '&oldestTransactionsFirst=' + oldestTransactionsFirst;
+ if (lastTransactionId) queryString += '&lastTransactionId=' + lastTransactionId;
+
+ // check for link to specific transaction and make sure we load enough to view it
+ if (hash && !lastTransactionId) {
+ var matches = hash.match(/^#txn-(\d+)$/);
+ if (matches) {
+ hashTransactionId = matches[1];
+ queryString += '&transactionId=' + hashTransactionId;
+ }
+ }
+
+ jQuery.ajax({
+ url: "<% $url %>" + queryString,
+ success: function(html) {
+ if(html) {
+ lastTransactionId = jQuery(html).filter('div.transaction').last().data('transactionId');
+ jQuery(".history-container").append(html);
+
+ if (hashTransactionId) { // focus transaction if we are following a link to it
+ hashTransactionId = null;
+ location.href = hash;
+ }
+ } else {
+ disableLoading = true;
+ }
+
+ isLoading = false;
+ removeLoadingMessage();
+ },
+ error: function(xhr, reason) {
+ isLoading = false;
+ loadingError(reason);
+ }
+ });
+ };
+
+ jQuery(window).scroll(function() {
+ if(jQuery(window).scrollTop() >= jQuery(document).height() - jQuery(window).height() - loadDistanceFromBottom) {
+ loadHistoryPage();
+ }
+ });
+
+ jQuery('.history-container').on('click', '.error-load-history a', function(e) {
+ e.preventDefault();
+ removeLoadLink();
+ disableLoading = false;
+ loadHistoryPage();
+ });
+
+ loadHistoryPage();
+});
+</script>
diff --git a/share/static/css/base/misc.css b/share/static/css/base/misc.css
index d42e01e..b59d3c6 100644
--- a/share/static/css/base/misc.css
+++ b/share/static/css/base/misc.css
@@ -89,3 +89,17 @@ textarea.messagebox, #cke_Content, #cke_UpdateContent {
.dashboard-subscription tr.frequency .value input {
margin-bottom: 0.75em;
}
+
+/* infinite history error message */
+
+.error-load-history {
+ background-color: #b32;
+ padding: 10px;
+ border-radius: 5px;
+ color: white;
+}
+
+.error-load-history a {
+ text-decoration: underline !important;
+ color: white !important;
+}
-----------------------------------------------------------------------
More information about the rt-commit
mailing list