Overriding files in lib/RT?

RT Users
1

Hey list,
How would I override /opt/rt4/lib/RT/Interface/Email.pm? I created
/opt/rt4/local/lib/RT/Interface/Email.pm, but that doesn’t seem to be
working. After clearing the mason cache, then restarting the server, my new
regex didn’t work. I’ll check that the change is correct, but all I did was
change a plus sign to an asterisk to require zero or more spaces instead of
one or more. It seems more likely that I didn’t do something correctly in
making my own copy of the file in question. I’ve done this for templates,
but never for anything under the lib directory.

Alex Hall
Automatic Distributors, IT department
ahall@autodist.com

2

Hi Alex,On Mon, Oct 31, 2016 at 11:09 AM, Alex Hall ahall@autodist.com wrote:

Hey list,
How would I override /opt/rt4/lib/RT/Interface/Email.pm?

Overlays.

https://docs.bestpractical.com/rt/4.4.1/RT/StyleGuide.html#EXTENDING-RT-CLASSES

It looks like there is also an outdated wiki article:

https://rt-wiki.bestpractical.com/wiki/ObjectModel

-m

3

To extend you should either add code in Email_Local.pm or Email_Overlay.pm.
If you name it as Email.pm then you have to copy all code from existing
module and modify it.

I’m not sure about differences between Overlay and Local but I think that
difference is for OO vs adding some functionality.

NileshOn 31-Oct-2016 9:45 PM, “Matt Zagrabelny” mzagrabe@d.umn.edu wrote:

Hi Alex,

On Mon, Oct 31, 2016 at 11:09 AM, Alex Hall ahall@autodist.com wrote:

Hey list,
How would I override /opt/rt4/lib/RT/Interface/Email.pm?

Overlays.

https://docs.bestpractical.com/rt/4.4.1/RT/StyleGuide.
html#EXTENDING-RT-CLASSES

It looks like there is also an outdated wiki article:

ObjectModel - Request Tracker Wiki

-m

RT 4.4 and RTIR training sessions, and a new workshop day!
https://bestpractical.com/training

  • Los Angeles - Q1 2017
4

Hi all,
Thanks for the responses, it’s partially working. When I use my
Email_Local.pm, the server refuses to start, yet I have no errors. Running
it through Perl’s checker reveals only:

Name “RT::Logger” used only once: possible typo at Email_Local.pm at line 31

Perl says everything else is fine. I pulled the single function I wanted to
modify out of the original Email.pm (ParseTicketId) and left it alone,
except for changing \s+ to \s* in the “if (my $@captures” line. As usual,
any errors that might be generated are going who knows where, so I’m not
sure where to start looking. As I said, Perl thinks this is fine save that
warning, but RT definitely doesn’t. Any thoughts? Here’s the file:

use strict;
use warnings;
no warnings qw(redefine);

package RT::Interface::Email;

#Takes a string and searches for [subjecttag #id]

#Returns the id if a match is found. Otherwise returns undef.

sub ParseTicketId {
my $Subject = shift;

my $rtname = RT->Config->Get('rtname');
my $test_name = RT->Config->Get('EmailSubjectTagRegex') ||

qr/\Q$rtname\E/i;

# We use @captures and pull out the last capture value to guard against
# someone using (...) instead of (?:...) in $EmailSubjectTagRegex.
my $id;
if ( my @captures = $Subject =~ /\[$test_name\s*\#(\d+)\s*\]/i ) {
    $id = $captures[-1];
} else {
    foreach my $tag ( RT->System->SubjectTag ) {
        next unless my @captures = $Subject =~

/[\Q$tag\E\s+#(\d+)\s*]/i;
$id = $captures[-1];
last;
}
}
return undef unless $id;

$RT::Logger->debug("Found a ticket ID. It's $id");
return $id;

}On Mon, Oct 31, 2016 at 12:18 PM, Nilesh me@nileshgr.com wrote:

To extend you should either add code in Email_Local.pm or
Email_Overlay.pm. If you name it as Email.pm then you have to copy all code
from existing module and modify it.

I’m not sure about differences between Overlay and Local but I think that
difference is for OO vs adding some functionality.

–
Nilesh

On 31-Oct-2016 9:45 PM, “Matt Zagrabelny” mzagrabe@d.umn.edu wrote:

Hi Alex,

On Mon, Oct 31, 2016 at 11:09 AM, Alex Hall ahall@autodist.com wrote:

Hey list,
How would I override /opt/rt4/lib/RT/Interface/Email.pm?

Overlays.

RT::StyleGuide - RT 4.4.1 Documentation - Best Practical
EXTENDING-RT-CLASSES

It looks like there is also an outdated wiki article:

ObjectModel - Request Tracker Wiki

-m

RT 4.4 and RTIR training sessions, and a new workshop day!
https://bestpractical.com/training

  • Los Angeles - Q1 2017

RT 4.4 and RTIR training sessions, and a new workshop day!
https://bestpractical.com/training

  • Los Angeles - Q1 2017

Alex Hall
Automatic Distributors, IT department
ahall@autodist.com

5

Hi all,
Thanks for the responses, it’s partially working. When I use my
Email_Local.pm, the server refuses to start, yet I have no errors. Running
it through Perl’s checker reveals only:

Name “RT::Logger” used only once: possible typo at Email_Local.pm at line 31

Perl says everything else is fine. I pulled the single function I wanted to
modify out of the original Email.pm (ParseTicketId) and left it alone,
except for changing \s+ to \s* in the “if (my $@captures” line. As usual,
any errors that might be generated are going who knows where, so I’m not
sure where to start looking. As I said, Perl thinks this is fine save that
warning, but RT definitely doesn’t. Any thoughts? Here’s the file:

Hi Alex,

Try running the fcgi process by hand and look for any errors. Sometimes,
the one function you pull has dependencies on other function in the file
which means that they would need to be in the new file as well. Running
it by hand gave a useful error for me.

Regards,
Ken

6

Sorry, but can you clarify “run FCGI by hand”? Currently, I run spawn-fcgi
to specify the address, port, and location of the RT FCGI server. All that
gives me is a success or error message on initial start, but any subsequent
errors don’t seem to be logged anywhere. This is the only way I know to get
the FCGI server running. How do you do it? I’d love a way that would give
me more information. Thanks.On Mon, Oct 31, 2016 at 4:29 PM, Kenneth Marshall ktm@rice.edu wrote:

On Mon, Oct 31, 2016 at 04:17:11PM -0400, Alex Hall wrote:

Hi all,
Thanks for the responses, it’s partially working. When I use my
Email_Local.pm, the server refuses to start, yet I have no errors.
Running
it through Perl’s checker reveals only:

Name “RT::Logger” used only once: possible typo at Email_Local.pm at
line 31

Perl says everything else is fine. I pulled the single function I wanted
to
modify out of the original Email.pm (ParseTicketId) and left it alone,
except for changing \s+ to \s* in the “if (my $@captures” line. As usual,
any errors that might be generated are going who knows where, so I’m not
sure where to start looking. As I said, Perl thinks this is fine save
that
warning, but RT definitely doesn’t. Any thoughts? Here’s the file:

Hi Alex,

Try running the fcgi process by hand and look for any errors. Sometimes,
the one function you pull has dependencies on other function in the file
which means that they would need to be in the new file as well. Running
it by hand gave a useful error for me.

Regards,
Ken

Alex Hall
Automatic Distributors, IT department
ahall@autodist.com

7

Hi Alex,

You may need to add the following to the end of your Email_Local.pm
file:

1;

Best Regards

MartinOn 2016-10-31 20:17, Alex Hall wrote:

Hi all,
Thanks for the responses, it’s partially working. When I use my
Email_Local.pm, the server refuses to start, yet I have no errors.
Running it through Perl’s checker reveals only:

Name “RT::Logger” used only once: possible typo at Email_Local.pm at
line 31

Perl says everything else is fine. I pulled the single function I
wanted to modify out of the original Email.pm (ParseTicketId) and left
it alone, except for changing \s+ to \s* in the “if (my $@captures”
line. As usual, any errors that might be generated are going who knows
where, so I’m not sure where to start looking. As I said, Perl thinks
this is fine save that warning, but RT definitely doesn’t. Any
thoughts? Here’s the file:

use strict;
use warnings;
no warnings qw(redefine);

package RT::Interface::Email;

#Takes a string and searches for [subjecttag #id]

#Returns the id if a match is found. Otherwise returns undef.

sub ParseTicketId {
my $Subject = shift;

my $rtname = RT->Config->Get('rtname');
my $test_name = RT->Config->Get('EmailSubjectTagRegex') ||

qr/\Q$rtname\E/i;

# We use @captures and pull out the last capture value to guard

against
# someone using (…) instead of (?:…) in $EmailSubjectTagRegex.
my $id;
if ( my @captures = $Subject =~ /[$test_name\s*#(\d+)\s*]/i ) {
$id = $captures[-1];
} else {
foreach my $tag ( RT->System->SubjectTag ) {
next unless my @captures = $Subject =~
/[\Q$tag\E\s+#(\d+)\s*]/i;
$id = $captures[-1];
last;
}
}
return undef unless $id;

$RT::Logger->debug("Found a ticket ID. It's $id");
return $id;

}

On Mon, Oct 31, 2016 at 12:18 PM, Nilesh me@nileshgr.com wrote:

To extend you should either add code in Email_Local.pm or
Email_Overlay.pm. If you name it as Email.pm then you have to copy
all code from existing module and modify it.

I’m not sure about differences between Overlay and Local but I think
that difference is for OO vs adding some functionality.

–
Nilesh

On 31-Oct-2016 9:45 PM, “Matt Zagrabelny” mzagrabe@d.umn.edu wrote:

Hi Alex,

On Mon, Oct 31, 2016 at 11:09 AM, Alex Hall ahall@autodist.com wrote:

Hey list,
How would I override /opt/rt4/lib/RT/Interface/Email.pm [1]?

Overlays.

RT::StyleGuide - RT 4.4.1 Documentation - Best Practical

[2]

It looks like there is also an outdated wiki article:

ObjectModel - Request Tracker Wiki [3]

-m

RT 4.4 and RTIR training sessions, and a new workshop day!
https://bestpractical.com/training [4]

  • Los Angeles - Q1 2017

RT 4.4 and RTIR training sessions, and a new workshop day!
https://bestpractical.com/training [4]

  • Los Angeles - Q1 2017

–

Alex Hall
Automatic Distributors, IT department
ahall@autodist.com

Links:

[1] http://l.pm
[2]
RT::StyleGuide - RT 4.4.1 Documentation - Best Practical
[3] ObjectModel - Request Tracker Wiki
[4] https://bestpractical.com/training

RT 4.4 and RTIR training sessions, and a new workshop day!
https://bestpractical.com/training

  • Los Angeles - Q1 2017