☰

Easy Property Rent Extension

Easily extend the rental property based on the previous rental agreement from your activity log

  1. // ==UserScript==
  2. // @name         Easy Property Rent Extension
  3. // @namespace    easy.property.rent.extension
  4. // @version      v2.3.0
  5. // @description  Easily extend the rental property based on the previous rental agreement from your activity log
  6. // @author       IceBlueFire [776]
  7. // @license      MIT
  8. // @match        https://www.torn.com/properties.php*
  9. // @icon         https://www.google.com/s2/favicons?sz=64&domain=torn.com
  10. // @grant        GM_xmlhttpRequest
  11. // @grant        GM_addStyle
  12. // @require      https://code.jquery.com/jquery-1.8.2.min.js
  13. // ==/UserScript==
  14.  
  15. /******************** CONFIG SETTINGS ********************/
  16. const apikey = "#######"; // Full access API key required to pull historical activity log data.
  17. const days_remaining = 3; // Number of days remaining or less to be included in reminders.
  18. const default_days = 7; // Default number of days to extend the lease if data can't be found.
  19. const default_cost = 5600000; // Default cost of lease extension if data can't be found.
  20. const properties = [13]; // Array of property types allowed for renting. Ex: [12, 13] for Castles and Private Islands. Reference property IDs below as necessary.
  21. const hex_color = "#8ABEEF"; // Hexcode to apply to the box.
  22. const debug = 0; // Leave alone unless you want console logs.
  23. /****************** END CONFIG SETTINGS *******************/
  24.  
  25. /* Property IDs
  26.  * 1 = Trailer;
  27.  * 2 = Apartment;
  28.  * 3 = Semi-Detached House;
  29.  * 4 = Detached House;
  30.  * 5 = Beach House;
  31.  * 6 = Chalet;
  32.  * 7 = Villa;
  33.  * 8 = Penthouse;
  34.  * 9 = Mansion;
  35.  * 10 = Ranch;
  36.  * 11 = Palace;
  37.  * 12 = Castle;
  38.  * 13 = Private Island;
  39. */
  40.  
  41.  
  42.  
  43. /******************** DO NOT TOUCH ANYTHING BELOW THIS ********************/
  44. $(document).ready(function() {
  45.     log("Ready");
  46.     let debounceTimeout;
  47.     let rentalHistoryCache = null;
  48.     let propertyListCache = null;
  49.     let current_page = null;
  50.     let property_details = null;
  51.     let hex_darker = "#53728f";
  52.     let player_id = $('#sidebarroot a[href*="profiles.php?XID="]').attr('href')?.match(/XID=(\d+)/)?.[1];
  53.  
  54.     function drawNavigation() {
  55.         let valid_properties = [];
  56.         let total_properties = 0;
  57.  
  58.         const navigation_div = `
  59.     <div id="icey-container" style="display:none;">
  60.     <div id="icey-property-rentals" class="m-top10">
  61.     <div class="icey-head">
  62.         <span class="icey-title">Easy Rental Extensions</span>
  63.     </div>
  64.     <div class="icey-content">
  65.     <a id="previous-button" class="torn-btn">Previous</a>
  66.     <div id="info-div" class="center-info"><p><strong>Rental Property Information</strong></p>
  67.     <p><span class="rentals-count">0</span> / <span class="total-count">0</span> properties requiring attention.</p>
  68.     <p class="viewing-rental"><span class="current-index">0</span> / <span class="rentals-count"></p>
  69.     </div>
  70.     <a id="next-button" class="torn-btn">Next</a>
  71.  
  72.     </div>
  73.     <hr class="page-head-delimiter m-top10 m-bottom10">
  74.     </div>
  75.     </div>
  76.     `;
  77.         if ($('#icey-property-rentals').length === 0) {
  78.             log('Insert navigation div');
  79.             $('#properties-page-wrap .content-title.m-bottom10').after(navigation_div);
  80.             const propertyList = propertyListCache ? Promise.resolve(propertyListCache) : getPropertyList();
  81.             propertyList.then(function(result) {
  82.                 if (!propertyListCache) {
  83.                     propertyListCache = result;
  84.                 }
  85.                 $.each(result.properties, function(key, value) {
  86.                     if (value.owner_id == player_id && properties.includes(value.property_type)) {
  87.                         total_properties++;
  88.                         if((key != result.property_id && !value.rented) || (value.rented && value.rented.days_left <= days_remaining)) {
  89.                             valid_properties.push(key);
  90.                         }
  91.                     }
  92.                 });
  93.  
  94.                 // Get the current property ID from the URL
  95.                 const current_property_id = getParam('ID');
  96.  
  97.                 if(current_property_id) {
  98.                     property_details = result.properties[current_property_id];
  99.                     injectOptionIntoEmptySlot('property-option-info', 'Happy: '+property_details.happy);
  100.                 }
  101.  
  102.                 let current_index = valid_properties.indexOf(current_property_id);
  103.                 let tab = 'offerExtension';
  104.  
  105.                 if (current_index > 0) {
  106.                     const previous_property_id = valid_properties[current_index - 1];
  107.                     if(result.properties[previous_property_id].rented) {
  108.                         tab = 'offerExtension';
  109.                     } else {
  110.                         tab = 'lease';
  111.                     }
  112.                     $('#previous-button').attr('href', `#/p=options&ID=${previous_property_id}&tab=${tab}`);
  113.                 } else {
  114.                     $('#previous-button').attr('href', '#').addClass('disabled'); // Disable if no previous
  115.                 }
  116.  
  117.                 // Handle the "Next" button
  118.                 if (current_index < valid_properties.length - 1) {
  119.                     const next_property_id = valid_properties[current_index === -1 ? 0 : current_index + 1];
  120.                     if(result.properties[next_property_id].rented) {
  121.                         tab = 'offerExtension';
  122.                     } else {
  123.                         tab = 'lease';
  124.                     }
  125.                     $('#next-button').attr('href', `#/p=options&ID=${next_property_id}&tab=${tab}`);
  126.                 } else {
  127.                     $('#next-button').attr('href', '#').addClass('disabled'); // Disable if no next
  128.                 }
  129.                 $('#icey-container .total-count').html(total_properties);
  130.                 $('#icey-container .rentals-count').html(valid_properties.length);
  131.                 if(current_index === -1 || current_page == 'properties') {
  132.                     $('#icey-container .viewing-rental').hide();
  133.                 } else {
  134.                     $('#icey-container .viewing-rental').show();
  135.                     $('#icey-container .current-index').html(current_index + 1);
  136.                 }
  137.                 setDynamicGradient();
  138.                 $('.icey-head').css('background', `linear-gradient(180deg, ${hex_color}, ${hex_darker})`);
  139.                 $('#icey-container').show();
  140.             });
  141.         }
  142.     }
  143.  
  144.  
  145.  
  146.     function checkTabAndRunScript() {
  147.         // Do the stuff!
  148.         var page = getParam('tab');
  149.         if (page === 'offerExtension') {
  150.             drawNavigation();
  151.             let current_renter = null;
  152.             let link = $('.offerExtension-form').find('a.h.t-blue');
  153.             if (link.length > 0) {
  154.                 current_renter = link.attr('href')?.match(/XID=(\d+)/)?.[1] || null;
  155.                 log("Renter: " + current_renter);
  156.                 getPreviousValues(current_renter);
  157.             } else {
  158.                 log("No renter found.");
  159.             }
  160.         } else if(page === 'lease') {
  161.             drawNavigation();
  162.             log("Add to rental market");
  163.             setDefaultLeaseFields();
  164.         } else if(page == null) {
  165.             drawNavigation();
  166.         } else {
  167.             log("Wrong properties tab.");
  168.         }
  169.     }
  170.  
  171.     function setDefaultLeaseFields()
  172.     {
  173.         const checkVisibility = setInterval(function() {
  174.             const marketDiv = $('#market');
  175.             if (marketDiv.is(':visible')) {
  176.                 // Access the input field and set its value
  177.                 $('#market').find('input.lease.input-money[data-name="money"]').val(default_cost);
  178.                 $('#market').find('input.lease.input-money[data-name="days"]').val(default_days);
  179.  
  180.                 clearInterval(checkVisibility); // Stop the interval once the value is set
  181.             }
  182.         }, 100); // Check every 100 milliseconds
  183.  
  184.         $('#market input[type="submit"]').prop('disabled', false);
  185.     }
  186.  
  187.     function getPreviousValues(current_renter) {
  188.         // Look for previous rental agreements and auto-fill input boxes
  189.         var duration = default_days || 0;
  190.         var cost = default_cost || 0;
  191.         const property_id = getParam('ID');
  192.         const activity = rentalHistoryCache ? Promise.resolve(rentalHistoryCache) : getRentalHistory();
  193.         activity.then(function(result) {
  194.             // Cache the result if not already cached
  195.             if (!rentalHistoryCache) {
  196.                 rentalHistoryCache = result;
  197.             }
  198.  
  199.             $.each(result.log, function(key, value) {
  200.                 if(value.data.property_id == property_id && value.data.renter == current_renter) {
  201.                     duration = value.data.days;
  202.                     cost = value.data.rent;
  203.                     return false;
  204.                 }
  205.             });
  206.             
  207.             // Target the input fields
  208.             let costInput = $('.offerExtension.input-money[data-name="offercost"]');
  209.             let daysInput = $('.offerExtension.input-money[data-name="days"]');
  210.  
  211.             // Set the values
  212.             costInput.val(cost);
  213.             daysInput.val(duration);
  214.             // costInput.tornInputMoney({buttonElement: null, skipBlurCheck: true});
  215.  
  216.             // Trigger events to mimic manual input
  217.             // costInput.trigger('input').trigger('change').trigger('keyup'); // Attempt to simulate input event for Torn
  218.             // daysInput.trigger('input').trigger('change').trigger('keyup'); // Attempt to simulate input event for Torn
  219.  
  220.             $('.offerExtension-form input[type="submit"]').prop('disabled', false);
  221.         });
  222.     }
  223.  
  224.     async function getRentalHistory() {
  225.         // Get the activity log for both rental extensions and new rental agreements
  226.         return new Promise(resolve => {
  227.             const request_url = `https://api.torn.com/user/?selections=log&key=`+apikey+`&log=5943,5937&comment=EasyRentalExtensions`;
  228.             GM_xmlhttpRequest ({
  229.                 method:     "GET",
  230.                 url:        request_url,
  231.                 headers:    {
  232.                     "Content-Type": "application/json"
  233.                 },
  234.                 onload: response => {
  235.                     try {
  236.                         const data = JSON.parse(response.responseText);
  237.                         if(!data) {
  238.                             log('No response from Torn API');
  239.                         } else {
  240.                             log('Log data fetched.');
  241.                             return resolve(data);
  242.                         }
  243.                     }
  244.                     catch (e) {
  245.                         console.error(e);
  246.                     }
  247.  
  248.                 },
  249.                 onerror: (e) => {
  250.                     console.error(e);
  251.                 }
  252.             })
  253.         });
  254.     }
  255.  
  256.     async function getPropertyList() {
  257.         // Get the activity log for both rental extensions and new rental agreements
  258.         return new Promise(resolve => {
  259.             const request_url = `https://api.torn.com/user/?selections=profile,properties&key=`+apikey+`&comment=EasyRentalExtensions`;
  260.             GM_xmlhttpRequest ({
  261.                 method:     "GET",
  262.                 url:        request_url,
  263.                 headers:    {
  264.                     "Content-Type": "application/json"
  265.                 },
  266.                 onload: response => {
  267.                     try {
  268.                         const data = JSON.parse(response.responseText);
  269.                         if(!data) {
  270.                             log('No response from Torn API');
  271.                         } else {
  272.                             log('Property data fetched.');
  273.                             return resolve(data);
  274.                         }
  275.                     }
  276.                     catch (e) {
  277.                         console.error(e);
  278.                     }
  279.  
  280.                 },
  281.                 onerror: (e) => {
  282.                     console.error(e);
  283.                 }
  284.             })
  285.         });
  286.     }
  287.  
  288.     function injectOptionIntoEmptySlot(iconClass, text) {
  289.         log("Adding details to property", text);
  290.         const emptySlot = $('ul.options-list.left li.empty').first();
  291.         if (emptySlot.length) {
  292.             emptySlot.removeClass('empty').addClass('custom-extension');
  293.             emptySlot.find('.p-icon').html(`<i class="${iconClass}"></i>`);
  294.             emptySlot.find('.desc').text(text);
  295.         }
  296.     }
  297.  
  298.     function getParam(name) {
  299.  
  300.        // Extract the part of the URL after the #
  301.         const fragment = window.location.href.split('#')[1];
  302.         if (!fragment) return null; // No fragment present
  303.  
  304.         // Treat the fragment like a query string
  305.         const results = new RegExp(name + '=([^&#]*)').exec(fragment);
  306.         return results ? decodeURIComponent(results[1]) : null; // Decode and return the value, or null if not found
  307.     }
  308.  
  309.     function log(message) {
  310.         if(debug){
  311.             console.log("[RentExtension] "+message);
  312.         }
  313.     }
  314.  
  315.     function setDynamicGradient() {
  316.         // Convert base hex to RGB
  317.         const baseRgb = hexToRgb(hex_color);
  318.  
  319.         // Create a darker shade by reducing brightness
  320.         const darkerRgb = darkenRgb(baseRgb, 0.7); // 0.7 is the factor for darkening
  321.  
  322.         // Convert the darker RGB back to hex
  323.         hex_darker = rgbToHex(darkerRgb.r, darkerRgb.g, darkerRgb.b);
  324.     }
  325.  
  326.     // Helper: Convert hex to RGB
  327.     function hexToRgb(hex) {
  328.         const bigint = parseInt(hex.replace('#', ''), 16);
  329.         return {
  330.             r: (bigint >> 16) & 255,
  331.             g: (bigint >> 8) & 255,
  332.             b: bigint & 255,
  333.         };
  334.     }
  335.  
  336.     // Helper: Darken an RGB color
  337.     function darkenRgb(rgb, factor) {
  338.         return {
  339.             r: Math.max(0, Math.min(255, Math.floor(rgb.r * factor))),
  340.             g: Math.max(0, Math.min(255, Math.floor(rgb.g * factor))),
  341.             b: Math.max(0, Math.min(255, Math.floor(rgb.b * factor))),
  342.         };
  343.     }
  344.  
  345.     // Helper: Convert RGB to hex
  346.     function rgbToHex(r, g, b) {
  347.         return `#${((1 << 24) + (r << 16) + (g << 8) + b).toString(16).slice(1).toUpperCase()}`;
  348.     }
  349.  
  350.     // Create an observer for the properties page to watch for page changes
  351.     // Select the target node
  352.     const targetNode = document.getElementById('properties-page-wrap');
  353.  
  354.     if (targetNode) {
  355.         // Create a MutationObserver to watch for changes
  356.         const observer = new MutationObserver((mutationsList) => {
  357.             clearTimeout(debounceTimeout); // Reset the debounce timeout on every change
  358.             debounceTimeout = setTimeout(() => {
  359.                 log("Content changed in #properties-page-wrap");
  360.                 current_page = getParam('p');
  361.                 checkTabAndRunScript(); // Run your script when content settles
  362.             }, 500); // Debounce for 500ms
  363.         });
  364.  
  365.         // Start observing the target node for configured mutations
  366.         observer.observe(targetNode, {
  367.             childList: true, // Watch for added/removed child nodes
  368.             subtree: true,  // Watch the entire subtree of the target node
  369.         });
  370.  
  371.         //console.log("MutationObserver is set up with debouncing.");
  372.     } else {
  373.         console.error("Target node #properties-page-wrap not found.");
  374.     }
  375.  
  376.     // Run the script initially in case the page is already on the correct tab
  377.     checkTabAndRunScript();
  378.  
  379.  
  380. });
  381. GM_addStyle(`
  382. #icey-container {
  383.     width: 100%;
  384. }
  385. .icey-head {
  386.     border-radius: 5px 5px 0 0;
  387.     height: 30px;
  388.     line-height: 30px;
  389.     width: 100%;
  390.     background: linear-gradient(180deg, #8ABEEF, #53728f);
  391.     color: white;
  392. }
  393. .icey-title {
  394.     width: 100%;
  395.     font-size: 13px;
  396.     letter-spacing: 1px;
  397.     font-weight: 700;
  398.     line-height: 16px;
  399.     flex-grow: 2;
  400.     padding: 5px;
  401.     margin: 5px;
  402.     text-transform: capitalize;
  403.     text-shadow: rgba(0, 0, 0, 0.65) 1px 1px 2px;
  404. }
  405. body.dark-mode .icey-content {
  406.     background: #333333;
  407. }
  408. body.dark-mode .icey-content td {
  409.     color: #c0c0c0;
  410. }
  411. .icey-content {
  412.     display: flex;
  413.     justify-content: space-between;
  414.     align-items: center;
  415.     padding: 5px;
  416.     background: #f2f2f2;
  417.     border-radius: 0 0 5px 5px;
  418.     box-shadow: 0 1px 3px #06060680;
  419. }
  420. .icey-content .torn-btn {
  421.     flex: 0 0 auto;
  422. }
  423.  
  424. .center-info {
  425.     flex: 1 1 auto;
  426.     text-align: center;
  427. }
  428.  
  429. `);