Issue #1295: enhance code comments

RotherOSS · Oct 8, 2021 · 934e23e · 934e23e
1 parent 17a1d34
commit 934e23e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageFS.pm b/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageFS.pm
@@ -247,6 +247,7 @@ sub ArticleDeleteAttachment {
     );
 }
 
+# no metadata is added
 sub ArticleWritePlain {
     my ( $Self, %Param ) = @_;
 
@@ -578,7 +579,7 @@ sub ArticleAttachmentIndexRaw {
     # get main object
     my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
 
-    # try fs
+    # try the files in the file system
     my @List = $MainObject->DirectoryRead(
         Directory => $Path,
         Filter    => "*",
@@ -771,6 +772,7 @@ sub ArticleAttachment {
     # get main object
     my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
 
+    # assuming the same order as in ArticleAttachmentIndexRaw
     my @List = $MainObject->DirectoryRead(
         Directory => $Path,
         Filter    => '*',

diff --git a/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageS3.pm b/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageS3.pm
@@ -152,6 +152,7 @@ sub ArticleDeleteAttachment {
     return 1;
 }
 
+# no metadata is added
 sub ArticleWritePlain {
     my ( $Self, %Param ) = @_;
 
@@ -167,8 +168,7 @@ sub ArticleWritePlain {
         }
     }
 
-    # write article to S3
-    # TODO_S3 third
+    # write plain to S3
     my $Prefix = $Self->_ArticlePrefix($Param{ArticleID});
     my $Key    = $Prefix . 'plain.txt';
     my $Response;
@@ -181,7 +181,7 @@ sub ArticleWritePlain {
         );
     }
 
-    warn Dumper( ['AAA', $Response, $Response->content ] );
+    warn Dumper( ['XXX ArticleWritePlain', $Response, $Response->content ] );
 
     # TODO: check success
     return 1;
@@ -299,6 +299,8 @@ sub ArticleAttachmentIndexRaw {
         return;
     }
 
+    # TODO: caching is essential here, because often ArticleAttachment() after ArticleAttachmentIndexRaw()
+
     my $Prefix = $Self->_ArticlePrefix($Param{ArticleID});
     my $Response;
     {