scancode_dbhandler.hpp

/*
 SPDX-FileCopyrightText: © 2021 Sarita Singh <saritasingh.0425@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
#ifndef SCANCODE_AGENT_DATABASE_HANDLER_HPP
#define SCANCODE_AGENT_DATABASE_HANDLER_HPP
 
#include <algorithm>
#include <iostream>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "libfossAgentDatabaseHandler.hpp"
#include "libfossUtils.hpp"
#include "libfossdbmanagerclass.hpp"
#include "match.hpp"
 
extern "C" {
#include "libfossology.h"
}
 
using namespace std;
 
using namespace fo;
 
#define RETURN_IF_FALSE(query) \
  do {\
    if (!(query)) {\
      return false;\
    }\
  } while(0)
 
 
#define MAX_TABLE_CREATION_RETRIES 5
 
class DatabaseEntry
{
public:
  DatabaseEntry();
  DatabaseEntry(Match match,unsigned long agentId, unsigned long pfileId);
  unsigned long agent_fk;                    
  unsigned long pfile_fk;                    
  std::string content;              
  std::string hash;                 
  std::string type;
  unsigned copy_startbyte;               
  unsigned copy_endbyte;                 
};
 
class ScancodeDatabaseHandler : public fo::AgentDatabaseHandler
{
public:
  ScancodeDatabaseHandler(fo::DbManager dbManager);
  ScancodeDatabaseHandler(ScancodeDatabaseHandler&& other) : fo::AgentDatabaseHandler(std::move(other)) {};
  ScancodeDatabaseHandler spawn() const;
  long saveLicenseMatch(int agentId, long pFileId, long licenseId, int percentMatch);
  bool insertNoResultInDatabase(int agentId, long pFileId, long licenseId);
 
  bool saveHighlightInfo(long licenseFileId, unsigned start, unsigned length);
  void insertOrCacheLicenseIdForName(std::string const& rfShortName, std::string const& rfFullname, std::string const& rfTexturl);
  unsigned long getCachedLicenseIdForName(std::string const& rfShortName) const;
  bool insertInDatabase(DatabaseEntry& entry) const;
  std::vector<unsigned long> queryFileIdsForUpload(int uploadId, bool ignoreFilesWithMimeType);
  bool createTables() const;
private:
  unsigned long selectOrInsertLicenseIdForName(std::string rfShortname, std::string rfFullname, std::string rfTexturl);
  std::unordered_map<std::string,long> licenseRefCache;
  struct ColumnDef
  {
    const char* name;               
    const char* type;               
    const char* creationFlags;      
  };
 
  static const ColumnDef columns_author[];
  static const ColumnDef columns_copyright[];
  bool createTableAgentEvents(string tablename) const;
  
  static const ColumnDef columns_author_event[];
  static const ColumnDef columns_copyright_event[];
  bool createTableAgentFindings(string tablename) const;
  std::string getColumnCreationString(const ColumnDef in[], size_t size) const;
};
 
#endif