init III

Perl OTRS/Kernel/Output/HTML/Article/Invalid.pm

@@ -0,0 +1,185 @@
+# --
+# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
+# --
+# This software comes with ABSOLUTELY NO WARRANTY. For details, see
+# the enclosed file COPYING for license information (GPL). If you
+# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
+# --
+
+package Kernel::Output::HTML::Article::Invalid;
+
+use strict;
+use warnings;
+
+use parent 'Kernel::Output::HTML::Article::Base';
+
+use Kernel::System::VariableCheck qw(:all);
+
+our @ObjectDependencies = (
+    'Kernel::Config',
+    'Kernel::Output::HTML::Layout',
+    'Kernel::System::CommunicationChannel',
+    'Kernel::System::HTMLUtils',
+    'Kernel::System::Log',
+    'Kernel::System::Ticket::Article',
+);
+
+=head2 ArticleFields()
+
+Returns common article fields for an invalid article.
+
+    my %ArticleFields = $LayoutObject->ArticleFields(
+        TicketID  => 123,   # (required)
+        ArticleID => 123,   # (required)
+    );
+
+Returns:
+
+    %ArticleFields = (
+        Sender => {                     # mandatory
+            Label => 'Sender',
+            Value => 'PackageName',
+            Prio  => 100,
+        },
+        Subject => {                    # mandatory
+            Label => 'Subject',
+            Value => 'Invalid article',
+            Prio  => 200,
+        },
+        ...
+    );
+
+=cut
+
+sub ArticleFields {
+    my ( $Self, %Param ) = @_;
+
+    for my $Needed (qw(TicketID ArticleID)) {
+        if ( !$Param{$Needed} ) {
+            $Kernel::OM->Get('Kernel::System::Log')->Log(
+                Priority => 'error',
+                Message  => "Need $Needed!",
+            );
+            return;
+        }
+    }
+
+    my $ArticleBackendObject = $Kernel::OM->Get('Kernel::System::Ticket::Article')->BackendForArticle(%Param);
+
+    my %Article = $ArticleBackendObject->ArticleGet(%Param);
+
+    # Get communication channel data.
+    my %CommunicationChannel = $Kernel::OM->Get('Kernel::System::CommunicationChannel')->ChannelGet(
+        ChannelID => $Article{CommunicationChannelID},
+    );
+
+    my %Result = (
+        Sender => {
+            Label    => 'Sender',
+            Value    => '-',
+            Realname => '-',
+            Prio     => 100,
+        },
+        Subject => {
+            Label => 'Subject',
+            Value => '-',
+            Prio  => 200,
+        },
+    );
+
+    return %Result;
+}
+
+=head2 ArticlePreview()
+
+Returns article preview for an invalid article.
+
+    $LayoutObject->ArticlePreview(
+        TicketID   => 123,     # (required)
+        ArticleID  => 123,     # (required)
+        ResultType => 'plain', # (optional) plain|HTML. Default HTML.
+        MaxLength  => 50,      # (optional) performs trimming (for plain result only)
+    );
+
+Returns article preview in scalar form:
+
+    $ArticlePreview = 'Preview of this article is not possible because...';
+
+=cut
+
+sub ArticlePreview {
+    my ( $Self, %Param ) = @_;
+
+    for my $Needed (qw(TicketID ArticleID)) {
+        if ( !$Param{$Needed} ) {
+            $Kernel::OM->Get('Kernel::System::Log')->Log(
+                Priority => 'error',
+                Message  => "Need $Needed!",
+            );
+            return;
+        }
+    }
+
+    if ( $Param{MaxLength} && !IsPositiveInteger( $Param{MaxLength} ) ) {
+        $Kernel::OM->Get('Kernel::System::Log')->Log(
+            Priority => 'error',
+            Message  => 'MaxLength must be positive integer!',
+        );
+
+        return;
+    }
+
+    my $ArticleBackendObject = $Kernel::OM->Get('Kernel::System::Ticket::Article')->BackendForArticle(%Param);
+
+    my %Article = $ArticleBackendObject->ArticleGet(%Param);
+
+    # Get communication channel data.
+    my %CommunicationChannel = $Kernel::OM->Get('Kernel::System::CommunicationChannel')->ChannelGet(
+        ChannelID => $Article{CommunicationChannelID},
+    );
+
+    my $Result = $Kernel::OM->Get('Kernel::Output::HTML::Layout')->Output(
+        TemplateFile => 'ArticleContent/Invalid',
+        Data         => \%CommunicationChannel,
+    );
+
+    if ( $Param{ResultType} && $Param{ResultType} eq 'plain' ) {
+        $Result = $Kernel::OM->Get('Kernel::System::HTMLUtils')->ToAscii(
+            String => $Result,
+        );
+
+        $Result =~ s{\n\s*\n}{\n}g;    # Remove extra new lines.
+        $Result =~ s/[^\S\n]+/ /g;     # Remove extra spaces.
+
+        # Trim to length.
+        if ( $Param{MaxLength} ) {
+            $Result = substr( $Result, 0, $Param{MaxLength} );
+        }
+    }
+
+    return $Result;
+}
+
+=head2 ArticleCustomerRecipientsGet()
+
+Dummy function. Invalid channel always returns no recipients.
+
+=cut
+
+sub ArticleCustomerRecipientsGet {
+    my ( $Self, %Param ) = @_;
+
+    for my $Needed (qw(TicketID ArticleID)) {
+        if ( !$Param{$Needed} ) {
+            $Kernel::OM->Get('Kernel::System::Log')->Log(
+                Priority => 'error',
+                Message  => "Need $Needed!",
+            );
+            return;
+        }
+    }
+
+    return;
+}
+
+1;