#5 Playlist Editor With Radio Reference Support (#760)

* WIP - Adds support for aliasing P25 Phase 2 tones.Playlist editor - adds editor support for alias actions

* Playlist editor implementation and integration into application is complete. Adds JavaFX window monitoring to persist window size/location across application runs.

Co-authored-by: Denny <denny@denny-desktop>
This commit is contained in:
Denny Sheirer
2020-04-26 11:53:43 +00:00
committed by GitHub
parent 39f6d6c831
commit cc52ae5bd7
290 changed files with 31251 additions and 15306 deletions

View File

@@ -0,0 +1,233 @@
/*
*
* * ******************************************************************************
* * Copyright (C) 2014-2020 Dennis Sheirer
* *
* * This program is free software: you can redistribute it and/or modify
* * it under the terms of the GNU General Public License as published by
* * the Free Software Foundation, either version 3 of the License, or
* * (at your option) any later version.
* *
* * This program is distributed in the hope that it will be useful,
* * but WITHOUT ANY WARRANTY; without even the implied warranty of
* * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* * GNU General Public License for more details.
* *
* * You should have received a copy of the GNU General Public License
* * along with this program. If not, see <http://www.gnu.org/licenses/>
* * *****************************************************************************
*
*
*/
package io.github.dsheirer.service.radioreference;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import io.github.dsheirer.rrapi.RadioReferenceException;
import io.github.dsheirer.rrapi.RadioReferenceService;
import io.github.dsheirer.rrapi.type.AgencyInfo;
import io.github.dsheirer.rrapi.type.AuthorizationInformation;
import io.github.dsheirer.rrapi.type.CountyInfo;
import io.github.dsheirer.rrapi.type.Frequency;
import io.github.dsheirer.rrapi.type.Site;
import io.github.dsheirer.rrapi.type.StateInfo;
import io.github.dsheirer.rrapi.type.SystemInformation;
import io.github.dsheirer.rrapi.type.Talkgroup;
import java.util.List;
/**
* Provides local caching for frequently retrieved items from the radio reference service
*/
public class CachingRadioReferenceService extends RadioReferenceService
{
private LoadingCache<Integer,AgencyInfo> mAgencyInfoCache;
private LoadingCache<Integer,CountyInfo> mCountyInfoCache;
private LoadingCache<Integer,StateInfo> mStateInfoCache;
private LoadingCache<Integer,SystemInformation> mSystemInfoCache;
private LoadingCache<Integer,List<Site>> mSystemSitesCache;
private LoadingCache<Integer,List<Frequency>> mSubCategoryFrequencyCache;
private LoadingCache<Integer,List<Talkgroup>> mTalkgroupCache;
/**
* Constructs an instance of the service
*
* @param authorizationInformation with username and password for accessing the web service
* @throws RadioReferenceException if there are any errors while accessing the service
*/
public CachingRadioReferenceService(AuthorizationInformation authorizationInformation) throws RadioReferenceException
{
super(authorizationInformation);
mAgencyInfoCache = CacheBuilder.newBuilder()
.maximumSize(1000)
.build(new CacheLoader<Integer,AgencyInfo>()
{
@Override
public AgencyInfo load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getAgencyInfo(key);
}
});
mCountyInfoCache = CacheBuilder.newBuilder()
.maximumSize(1000)
.build(new CacheLoader<Integer,CountyInfo>()
{
@Override
public CountyInfo load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getCountyInfo(key);
}
});
mStateInfoCache = CacheBuilder.newBuilder()
.maximumSize(100)
.build(new CacheLoader<Integer,StateInfo>()
{
@Override
public StateInfo load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getStateInfo(key);
}
});
mSystemInfoCache = CacheBuilder.newBuilder()
.maximumSize(100)
.build(new CacheLoader<Integer,SystemInformation>()
{
@Override
public SystemInformation load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getSystemInformation(key);
}
});
mSystemSitesCache = CacheBuilder.newBuilder()
.maximumSize(1000)
.build(new CacheLoader<Integer,List<Site>>()
{
@Override
public List<Site> load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getSites(key);
}
});
mSubCategoryFrequencyCache = CacheBuilder.newBuilder()
.maximumSize(1000)
.build(new CacheLoader<Integer,List<Frequency>>()
{
@Override
public List<Frequency> load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getSubCategoryFrequencies(key);
}
});
mTalkgroupCache = CacheBuilder.newBuilder()
.maximumSize(100)
.build(new CacheLoader<Integer,List<Talkgroup>>()
{
@Override
public List<Talkgroup> load(Integer key) throws Exception
{
return CachingRadioReferenceService.super.getTalkgroups(key);
}
});
}
@Override
public AgencyInfo getAgencyInfo(int agencyId) throws RadioReferenceException
{
try
{
return mAgencyInfoCache.get(agencyId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getAgencyInfo(agencyId);
}
}
@Override
public CountyInfo getCountyInfo(final int countyId) throws RadioReferenceException
{
try
{
return mCountyInfoCache.get(countyId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getCountyInfo(countyId);
}
}
@Override
public StateInfo getStateInfo(final int stateId) throws RadioReferenceException
{
try
{
return mStateInfoCache.get(stateId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getStateInfo(stateId);
}
}
@Override
public SystemInformation getSystemInformation(int systemId) throws RadioReferenceException
{
try
{
return mSystemInfoCache.get(systemId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getSystemInformation(systemId);
}
}
@Override
public List<Site> getSites(int systemId) throws RadioReferenceException
{
try
{
return mSystemSitesCache.get(systemId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getSites(systemId);
}
}
@Override
public List<Frequency> getSubCategoryFrequencies(int subCategoryId) throws RadioReferenceException
{
try
{
return mSubCategoryFrequencyCache.get(subCategoryId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getSubCategoryFrequencies(subCategoryId);
}
}
@Override
public List<Talkgroup> getTalkgroups(int systemId) throws RadioReferenceException
{
try
{
return mTalkgroupCache.get(systemId);
}
catch(Exception e)
{
return CachingRadioReferenceService.super.getTalkgroups(systemId);
}
}
}

View File

@@ -0,0 +1,231 @@
/*
*
* * ******************************************************************************
* * Copyright (C) 2014-2020 Dennis Sheirer
* *
* * This program is free software: you can redistribute it and/or modify
* * it under the terms of the GNU General Public License as published by
* * the Free Software Foundation, either version 3 of the License, or
* * (at your option) any later version.
* *
* * This program is distributed in the hope that it will be useful,
* * but WITHOUT ANY WARRANTY; without even the implied warranty of
* * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* * GNU General Public License for more details.
* *
* * You should have received a copy of the GNU General Public License
* * along with this program. If not, see <http://www.gnu.org/licenses/>
* * *****************************************************************************
*
*
*/
package io.github.dsheirer.service.radioreference;
import io.github.dsheirer.preference.UserPreferences;
import io.github.dsheirer.rrapi.RadioReferenceException;
import io.github.dsheirer.rrapi.RadioReferenceService;
import io.github.dsheirer.rrapi.type.AuthorizationInformation;
import io.github.dsheirer.rrapi.type.UserInfo;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleStringProperty;
import javafx.beans.property.StringProperty;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Scanner;
/**
* Service interface to radioreference.com data API with caching for Flavor, Mode, Type and Tag values.
*/
public class RadioReference
{
private static final Logger mLog = LoggerFactory.getLogger(RadioReference.class);
public static final String SDRTRUNK_APP_KEY = "88969092";
private RadioReferenceService mRadioReferenceService;
private UserPreferences mUserPreferences;
private AuthorizationInformation mAuthorizationInformation;
private StringProperty mUserName = new SimpleStringProperty();
private StringProperty mPassword = new SimpleStringProperty();
private StringProperty mAccountExpiresProperty = new SimpleStringProperty();
private BooleanProperty mAvailable = new SimpleBooleanProperty();
/**
* Constructs an instance of the radio reference service
* @param userPreferences for user credentials and other settings
*/
public RadioReference(UserPreferences userPreferences)
{
mUserPreferences = userPreferences;
}
/**
* Externally monitored and controlled status indicator for the service logged-on state
*/
public BooleanProperty availableProperty()
{
return mAvailable;
}
/**
* User name for radio reference account
*/
public StringProperty userNameProperty()
{
return mUserName;
}
/**
* User name for radio reference account
*/
public StringProperty passwordProperty()
{
return mPassword;
}
/**
* Read only user name for radio reference account
*/
public StringProperty accountExpiresProperty()
{
return mAccountExpiresProperty;
}
/**
* Provides access to the encapsulated radio reference service.
*
* Note: users of this service should call getService() EVERY time they want to make a call to the service. Any
* changes to the user credentials after the service has been accessed will cause the service to be recreated.
*
* @return service
* @throws RadioReferenceException if there is an issue creating the service (ie login credentials missing)
*/
public RadioReferenceService getService() throws RadioReferenceException
{
if(mRadioReferenceService == null)
{
AuthorizationInformation authorizationInformation = getAuthorizationInformation();
if(authorizationInformation != null)
{
//Use the caching version of the service to cache frequently used values
mRadioReferenceService = new CachingRadioReferenceService(authorizationInformation);
}
}
if(mRadioReferenceService == null)
{
throw new RadioReferenceException("Please set username or password to non-null value");
}
return mRadioReferenceService;
}
/**
* Tests the connection to radio reference service using the provided credentials.
* @param userName for radio reference account
* @param password for radio reference account
* @return true if the test is successful
* @throws RadioReferenceException if there are any issues with the connection
*/
public static boolean testConnection(String userName, String password) throws RadioReferenceException
{
AuthorizationInformation credentials = new AuthorizationInformation(SDRTRUNK_APP_KEY, userName, password);
RadioReferenceService service = new RadioReferenceService(credentials);
service.getUserInfo();
return true;
}
/**
* Login with credentials
*/
private void login()
{
try
{
UserInfo userInfo = getService().getUserInfo();
accountExpiresProperty().setValue(userInfo.getExpirationDate());
availableProperty().set(true);
}
catch(RadioReferenceException rre)
{
accountExpiresProperty().setValue(null);
availableProperty().set(false);
}
}
/**
* Creates an authorization information instance with the application key and the provided credentials
* @param userName to login
* @param password to login
* @return an instance
*/
public static AuthorizationInformation getAuthorizatonInformation(String userName, String password)
{
return new AuthorizationInformation(SDRTRUNK_APP_KEY, userName, password);
}
/**
* Authorization Information object for use with radio reference service
* @return instance or null if the user credentials are not set
*/
private AuthorizationInformation getAuthorizationInformation()
{
return mAuthorizationInformation;
}
/**
* Applies the credentials and attempts to login to the radio reference service
* @param authorizationInformation
*/
public void setAuthorizationInformation(AuthorizationInformation authorizationInformation)
{
mAuthorizationInformation = authorizationInformation;
mUserName.setValue(authorizationInformation.getUserName());
mPassword.setValue(authorizationInformation.getPassword());
//Set the service to null so that the next call to getService() will recreate it
if(mRadioReferenceService != null)
{
mRadioReferenceService = null;
}
login();
}
public static void main(String[] args)
{
UserPreferences userPreferences = new UserPreferences();
RadioReference radioReference = new RadioReference(userPreferences);
AuthorizationInformation credentials = userPreferences.getRadioReferencePreference().getAuthorizationInformation();
if(credentials == null)
{
Scanner scanner = new Scanner(System.in);
System.out.print("Username: ");
String username = scanner.next();
System.out.print("Password: ");
String password = scanner.next();
credentials = getAuthorizatonInformation(username, password);
}
radioReference.setAuthorizationInformation(credentials);
if(radioReference.availableProperty().get())
{
try
{
UserInfo userInfo = radioReference.getService().getUserInfo();
System.out.println("User Name: " + userInfo.getUserName() + " Account Expires:" + userInfo.getExpirationDate());
}
catch(RadioReferenceException rre)
{
mLog.error("Error", rre);
}
}
}
}