Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for adding links to assets #1

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Support for adding links to assets #1

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2193e9d
Support for adding links to assets
Jul 3, 2021
160bb22
Fix a spelling mistake
Jul 21, 2022
c5c0a34
Fix adding multiple links
puck Jul 22, 2022
a513f83
Fix common spreadsheet issue of making it Asset
puck Jul 22, 2022
be9027d
Delete links omitted from the CSV
puck Jul 22, 2022
26c1cea
Move the logic for handling links to a function
puck Jul 23, 2022
9aef937
Add some commentary and more link types
puck Jul 23, 2022
3507000
Fix comment wrapping, update docs.
puck Jul 23, 2022
e907d69
Simplify how we track which links we need to delete.
puck Jul 23, 2022
2fdb5de
Improve docs for links
Feb 5, 2023
eeeee67
Be more restrictive to only fold Asset that we want
Feb 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 132 additions & 2 deletions lib/RT/Extension/Assets/Import/CSV.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ $Data::Dumper::Deparse = 1;

our $VERSION = '2.4';

# Can we just load or construct this from RT::Link?
# Keep this as a subset as I think some of the other link types shouldn't
# be imported.
my %link_types = (
Member => { Type => 'MemberOf' },
Members => { Type => 'MemberOf' },
MemberOf => { Type => 'MemberOf' },
Parent => { Type => 'MemberOf' },
Parents => { Type => 'MemberOf' },
Child => { Type => 'MemberOf' },
Children => { Type => 'MemberOf' },
RefersTo => { Type => 'RefersTo' },
ReferredToBy => { Type => 'RefersTo' },
DependsOn => { Type => 'DependsOn' },
DependedOnBy => { Type => 'DependsOn' },
);

sub _column {
ref($_[0]) ? (ref($_[0]) eq "CODE" ?
"code reference" :
Expand Down Expand Up @@ -76,6 +93,8 @@ sub run {
# no-op, these are fine
} elsif ( RT::Asset->HasRole($fieldname) ) {
# no-op, roles are fine
} elsif ( defined $link_types{$fieldname} ) {
# no-op, links are fine
} else {
RT->Logger->warning(
"Unknown asset field $fieldname for "._column($field2csv->{$fieldname}).", skipping");
Expand Down Expand Up @@ -178,7 +197,7 @@ sub run {
}

my $asset = $assets->First;
my $changes;
my $changes = 0;
for my $field ( keys %$field2csv ) {
my $value = $class->get_value( $field2csv->{$field}, $item );
next unless defined $value and length $value;
Expand Down Expand Up @@ -236,7 +255,11 @@ sub run {
$value = $catalog->id;
}

if ($asset->$field ne $value) {
if (defined $link_types{$field}) {
# Manage links to other tickets/assets or to URLs
process_links_field($asset, $i, $field, $value, \$changes);

} elsif ($asset->$field ne $value) {
$changes++;
unless ( $args{DryRun} ) {
my $method = "Set" . $field;
Expand Down Expand Up @@ -425,6 +448,93 @@ sub parse_csv {
return @items;
}

sub process_links_field {
my $asset = shift;
my $i = shift;
my $field = shift;
my $value = shift;
my $changes = shift;

my $Type = $link_types{$field}{Type};
my $mode = $RT::Link::TYPEMAP{$Type}->{Mode};
my $ModeObj = "${mode}Obj";

# A common issue I encounter is spreadsheets capitalising asset to be
# Asset. Fix that.
$value =~ s/Asset:(\d)/asset:$1/g;

# Find all the existing links so we can delete links not present in the
# CSV. Assume all should be removed, unless we find them. Only consider
# links which are Tickets, Assets or links to outside RT.
my %existing_links;
my $links = $asset->$Type;
while (my $link = $links->Next) {
my $ToObj = $link->$ModeObj;
next unless ! $ToObj
|| $ToObj->isa('RT::Ticket')
|| $ToObj->isa('RT::Asset');
$existing_links{$link->id} = [ $Type, $link->Target ];
}

# Allow comma separated list of things to link to.
AddLink: for my $target (split(/,\s*/, $value)) {
# Check the existing links
while (my $link = $links->Next) {
my $ToObj = $link->$ModeObj;

if (! $ToObj) {
# A link outside of RT
if ($link->$mode eq $target) {
delete $existing_links{$link->id};
next AddLink;
}
} else {

# We only allow linking to Tickets and Assets, is that right?
next unless $ToObj->isa('RT::Ticket') || $ToObj->isa('RT::Asset');

if ($ToObj->isa('RT::Asset') && $target =~ /^asset:(\d+)$/) {
if ($ToObj->id == $1) {
delete $existing_links{$link->id};
next AddLink;
}
} elsif ($ToObj->isa('RT::Ticket') && $target =~ /^\d+$/) {
if ($ToObj->id == $value) {
delete $existing_links{$link->id};
next AddLink;
}
}
}
}

my ($ok, $msg) = $asset->AddLink(
Type => $Type,
$mode => $target,
);
if ($ok) {
if ($msg ne 'Link already exists') {
RT->Logger->info("Added $Type link for field $field to $target for row $i (asset " . $asset->id . "): $msg");
$$changes++;
}
} else {
RT->Logger->error("Failed to add $Type link $field to $target for row $i: $msg");
}
}

# Delete any links to URLs, Tickets or Assets not present in the CSV.
for my $link (values %existing_links) {
my $Type = @{ $link }[0];
my $Target = @{ $link }[1];
my ($ok, $msg) = $asset->DeleteLink(Type => $Type, Target => $Target);
if ($ok && $msg =~ /no longer member of/) {
RT->Logger->info("Deleted $Type link for field $field to $Target for row $i (asset " . $asset->id . "): $msg");
$$changes++;
} else {
RT->Logger->error("Failed to delete $Type from $Target for row $i (asset " . $asset->id . "): $msg");
}
}
}

=head1 NAME

RT-Extension-Assets-Import-CSV - RT Assets Import from CSV
Expand Down Expand Up @@ -551,6 +661,26 @@ L<Text::CSV_XS>:
The only default option is C<binary =E<gt> 1>. More information is available
in the L<Text::CSV_XS> documentation.

=head2 Links

You can create links to tickets, other assets or URLs by using the relationship
name, then you can use a comma separated list of tickets or assets (assets
need a prefix of "assets:"). For example:

Set( %AssetsImportFieldMapping,
'id' => 'serviceTag',
'Name' => 'description',
'Parents' => 'parent',
);

The "parent" column could then have entries like "123,256", "assets:123" or "123,assets:42".

Supported fields: Members, Children, ReferredToBy, DependedOnBy, MemberOf,
Parents, RefersTo, DependsOn

If an asset has links to tickets, assets or URLs which aren't mentioned in
the field in the CSV file, then those links will be removed.

=head1 AUTHOR

Best Practical Solutions, LLC E<lt>[email protected]<gt>
Expand Down