Issue #1295: enhance code comments and POD

RotherOSS · Oct 8, 2021 · e27bd21 · e27bd21
1 parent f0f97aa
commit e27bd21
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageFS.pm b/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageFS.pm
@@ -63,9 +63,9 @@ sub new {
     # Call new() on Base.pm to execute the common code.
     my $Self = $Type->SUPER::new(%Param);
 
+    # create a new directory every new day
     my $ArticleContentPath = $Self->BuildArticleContentPath();
     my $ArticleDir         = "$Self->{ArticleDataDir}/$ArticleContentPath/";
-
     mkpath( $ArticleDir, 0, 0770 );    ## no critic qw(ValuesAndExpressions::ProhibitLeadingZeros)
 
     # Check write permissions.
@@ -320,6 +320,8 @@ sub ArticleWriteAttachment {
     # prepare/filter ArticleID
     $Param{ArticleID} = quotemeta( $Param{ArticleID} );
     $Param{ArticleID} =~ s/\0//g;
+
+    # define path
     my $ContentPath = $Self->_ArticleContentPathGet(
         ArticleID => $Param{ArticleID},
     );

diff --git a/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageS3.pm b/Kernel/System/Ticket/Article/Backend/MIMEBase/ArticleStorageS3.pm
@@ -357,6 +357,7 @@ sub ArticleAttachment {
     return;
 }
 
+# the final delimiter is part of the prefix
 sub _ArticlePrefix {
     my ($Self, $ArticleID) = @_;
 

diff --git a/Kernel/System/Ticket/Article/Backend/MIMEBase/Base.pm b/Kernel/System/Ticket/Article/Backend/MIMEBase/Base.pm
@@ -69,6 +69,9 @@ Generate a base article content path for article storage in the file system.
 
     my $ArticleContentPath = $BackendObject->BuildArticleContentPath();
 
+This is useful in file system based storage backends because there shouldn't be too many entries in a directory.
+A different content path, in the form YYYY/MM/DD is generated for every day.
+
 =cut
 
 sub BuildArticleContentPath {